-
Notifications
You must be signed in to change notification settings - Fork 80
/
get_object_request_response.go
186 lines (141 loc) · 8.84 KB
/
get_object_request_response.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
// Copyright (c) 2016, 2018, 2020, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
package objectstorage
import (
"github.com/oracle/oci-go-sdk/common"
"io"
"net/http"
)
// GetObjectRequest wrapper for the GetObject operation
type GetObjectRequest struct {
// The Object Storage namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The name of the bucket. Avoid entering confidential information.
// Example: `my-new-bucket1`
BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
// The name of the object. Avoid entering confidential information.
// Example: `test/object1.log`
ObjectName *string `mandatory:"true" contributesTo:"path" name:"objectName"`
// VersionId used to identify a particular version of the object
VersionId *string `mandatory:"false" contributesTo:"query" name:"versionId"`
// The entity tag (ETag) to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object.
// For uploading a part, this is the entity tag of the target part.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the object
// already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a
// part, this is the entity tag of the target part.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Optional byte range to fetch, as described in RFC 7233 (https://tools.ietf.org/html/rfc7233#section-2.1).
// Note that only a single range of bytes is supported.
Range *string `mandatory:"false" contributesTo:"header" name:"range"`
// The optional header that specifies "AES256" as the encryption algorithm. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerAlgorithm *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-algorithm"`
// The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or
// decrypt the data. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKey *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key"`
// The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This
// value is used to check the integrity of the encryption key. For more information, see
// Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).
OpcSseCustomerKeySha256 *string `mandatory:"false" contributesTo:"header" name:"opc-sse-customer-key-sha256"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetObjectRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request GetObjectRequest) HTTPRequest(method, path string) (http.Request, error) {
return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetObjectRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// GetObjectResponse wrapper for the GetObject operation
type GetObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
// request, provide this request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The entity tag (ETag) for the object.
ETag *string `presentIn:"header" name:"etag"`
// The user-defined metadata for the object.
OpcMeta map[string]string `presentIn:"header-collection" prefix:"opc-meta-"`
// The object size in bytes.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// Content-Range header for range requests, per RFC 7233 (https://tools.ietf.org/html/rfc7233#section-4.2).
ContentRange *string `presentIn:"header" name:"content-range"`
// Content-MD5 header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.15).
// Unavailable for objects uploaded using multipart upload.
ContentMd5 *string `presentIn:"header" name:"content-md5"`
// Only applicable to objects uploaded using multipart upload.
// Base-64 representation of the multipart object hash.
// The multipart object hash is calculated by taking the MD5 hashes of the parts,
// concatenating the binary representation of those hashes in order of their part numbers,
// and then calculating the MD5 hash of the concatenated values.
OpcMultipartMd5 *string `presentIn:"header" name:"opc-multipart-md5"`
// Content-Type header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.17).
ContentType *string `presentIn:"header" name:"content-type"`
// Content-Language header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.12).
ContentLanguage *string `presentIn:"header" name:"content-language"`
// Content-Encoding header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.11).
ContentEncoding *string `presentIn:"header" name:"content-encoding"`
// Cache-Control header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.9).
CacheControl *string `presentIn:"header" name:"cache-control"`
// Content-Disposition header, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-19.5.1).
ContentDisposition *string `presentIn:"header" name:"content-disposition"`
// The object modification time, as described in RFC 2616 (https://tools.ietf.org/html/rfc2616#section-14.29).
LastModified *common.SDKTime `presentIn:"header" name:"last-modified"`
// The current state of the object.
ArchivalState GetObjectArchivalStateEnum `presentIn:"header" name:"archival-state"`
// Time that the object is returned to the archived state. This field is only present for restored objects.
TimeOfArchival *common.SDKTime `presentIn:"header" name:"time-of-archival"`
// VersionId of the object requested
VersionId *string `presentIn:"header" name:"version-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetObjectResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response GetObjectResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// GetObjectArchivalStateEnum Enum with underlying type: string
type GetObjectArchivalStateEnum string
// Set of constants representing the allowable values for GetObjectArchivalStateEnum
const (
GetObjectArchivalStateAvailable GetObjectArchivalStateEnum = "AVAILABLE"
GetObjectArchivalStateArchived GetObjectArchivalStateEnum = "ARCHIVED"
GetObjectArchivalStateRestoring GetObjectArchivalStateEnum = "RESTORING"
GetObjectArchivalStateRestored GetObjectArchivalStateEnum = "RESTORED"
)
var mappingGetObjectArchivalState = map[string]GetObjectArchivalStateEnum{
"AVAILABLE": GetObjectArchivalStateAvailable,
"ARCHIVED": GetObjectArchivalStateArchived,
"RESTORING": GetObjectArchivalStateRestoring,
"RESTORED": GetObjectArchivalStateRestored,
}
// GetGetObjectArchivalStateEnumValues Enumerates the set of values for GetObjectArchivalStateEnum
func GetGetObjectArchivalStateEnumValues() []GetObjectArchivalStateEnum {
values := make([]GetObjectArchivalStateEnum, 0)
for _, v := range mappingGetObjectArchivalState {
values = append(values, v)
}
return values
}