-
Notifications
You must be signed in to change notification settings - Fork 80
/
get_object_request_response.go
341 lines (272 loc) · 15.3 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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
// Copyright (c) 2016, 2018, 2024, 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 (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"io"
"net/http"
"strings"
)
// GetObjectRequest wrapper for the GetObject operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/GetObject.go.html to see an example of how to use GetObjectRequest.
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 with the ETag of an existing resource. If the specified ETag matches the ETag of
// the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload
// the resource.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not
// match the ETag of the existing resource, the request returns the expected response. If the ETag matches
// the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
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"`
// Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.
HttpResponseContentDisposition *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentDisposition"`
// Specify this query parameter to override the Cache-Control response header in the GetObject response.
HttpResponseCacheControl *string `mandatory:"false" contributesTo:"query" name:"httpResponseCacheControl"`
// Specify this query parameter to override the Content-Type response header in the GetObject response.
HttpResponseContentType *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentType"`
// Specify this query parameter to override the Content-Language response header in the GetObject response.
HttpResponseContentLanguage *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentLanguage"`
// Specify this query parameter to override the Content-Encoding response header in the GetObject response.
HttpResponseContentEncoding *string `mandatory:"false" contributesTo:"query" name:"httpResponseContentEncoding"`
// Specify this query parameter to override the Expires response header in the GetObject response.
HttpResponseExpires *string `mandatory:"false" contributesTo:"query" name:"httpResponseExpires"`
// 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, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error) {
_, err := request.ValidateEnumValue()
if err != nil {
return http.Request{}, err
}
return common.MakeDefaultHTTPRequestWithTaggedStructAndExtraHeaders(method, path, request, extraHeaders)
}
// BinaryRequestBody implements the OCIRequest interface
func (request GetObjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// ReplaceMandatoryParamInPath replaces the mandatory parameter in the path with the value provided.
// Not all services are supporting this feature and this method will be a no-op for those services.
func (request GetObjectRequest) ReplaceMandatoryParamInPath(client *common.BaseClient, mandatoryParamMap map[string][]common.TemplateParamForPerRealmEndpoint) {
if mandatoryParamMap["namespaceName"] != nil {
templateParam := mandatoryParamMap["namespaceName"]
for _, template := range templateParam {
replacementParam := *request.NamespaceName
if template.EndsWithDot {
replacementParam = replacementParam + "."
}
client.Host = strings.Replace(client.Host, template.Template, replacementParam, -1)
}
}
if mandatoryParamMap["bucketName"] != nil {
templateParam := mandatoryParamMap["bucketName"]
for _, template := range templateParam {
replacementParam := *request.BucketName
if template.EndsWithDot {
replacementParam = replacementParam + "."
}
client.Host = strings.Replace(client.Host, template.Template, replacementParam, -1)
}
}
if mandatoryParamMap["objectName"] != nil {
templateParam := mandatoryParamMap["objectName"]
for _, template := range templateParam {
replacementParam := *request.ObjectName
if template.EndsWithDot {
replacementParam = replacementParam + "."
}
client.Host = strings.Replace(client.Host, template.Template, replacementParam, -1)
}
}
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetObjectRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (request GetObjectRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// 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 storage tier that the object is stored in.
StorageTier GetObjectStorageTierEnum `presentIn:"header" name:"storage-tier"`
// Archival state of an object. This field is set only for objects in Archive tier.
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
VersionId *string `presentIn:"header" name:"version-id"`
// The date and time after which the object is no longer cached by a browser, proxy, or other caching entity. See
// RFC 2616 (https://tools.ietf.org/rfc/rfc2616#section-14.21).
Expires *common.SDKTime `presentIn:"header" name:"expires"`
// 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
}
// GetObjectStorageTierEnum Enum with underlying type: string
type GetObjectStorageTierEnum string
// Set of constants representing the allowable values for GetObjectStorageTierEnum
const (
GetObjectStorageTierStandard GetObjectStorageTierEnum = "Standard"
GetObjectStorageTierInfrequentaccess GetObjectStorageTierEnum = "InfrequentAccess"
GetObjectStorageTierArchive GetObjectStorageTierEnum = "Archive"
)
var mappingGetObjectStorageTierEnum = map[string]GetObjectStorageTierEnum{
"Standard": GetObjectStorageTierStandard,
"InfrequentAccess": GetObjectStorageTierInfrequentaccess,
"Archive": GetObjectStorageTierArchive,
}
var mappingGetObjectStorageTierEnumLowerCase = map[string]GetObjectStorageTierEnum{
"standard": GetObjectStorageTierStandard,
"infrequentaccess": GetObjectStorageTierInfrequentaccess,
"archive": GetObjectStorageTierArchive,
}
// GetGetObjectStorageTierEnumValues Enumerates the set of values for GetObjectStorageTierEnum
func GetGetObjectStorageTierEnumValues() []GetObjectStorageTierEnum {
values := make([]GetObjectStorageTierEnum, 0)
for _, v := range mappingGetObjectStorageTierEnum {
values = append(values, v)
}
return values
}
// GetGetObjectStorageTierEnumStringValues Enumerates the set of values in String for GetObjectStorageTierEnum
func GetGetObjectStorageTierEnumStringValues() []string {
return []string{
"Standard",
"InfrequentAccess",
"Archive",
}
}
// GetMappingGetObjectStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingGetObjectStorageTierEnum(val string) (GetObjectStorageTierEnum, bool) {
enum, ok := mappingGetObjectStorageTierEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// GetObjectArchivalStateEnum Enum with underlying type: string
type GetObjectArchivalStateEnum string
// Set of constants representing the allowable values for GetObjectArchivalStateEnum
const (
GetObjectArchivalStateArchived GetObjectArchivalStateEnum = "Archived"
GetObjectArchivalStateRestoring GetObjectArchivalStateEnum = "Restoring"
GetObjectArchivalStateRestored GetObjectArchivalStateEnum = "Restored"
)
var mappingGetObjectArchivalStateEnum = map[string]GetObjectArchivalStateEnum{
"Archived": GetObjectArchivalStateArchived,
"Restoring": GetObjectArchivalStateRestoring,
"Restored": GetObjectArchivalStateRestored,
}
var mappingGetObjectArchivalStateEnumLowerCase = map[string]GetObjectArchivalStateEnum{
"archived": GetObjectArchivalStateArchived,
"restoring": GetObjectArchivalStateRestoring,
"restored": GetObjectArchivalStateRestored,
}
// GetGetObjectArchivalStateEnumValues Enumerates the set of values for GetObjectArchivalStateEnum
func GetGetObjectArchivalStateEnumValues() []GetObjectArchivalStateEnum {
values := make([]GetObjectArchivalStateEnum, 0)
for _, v := range mappingGetObjectArchivalStateEnum {
values = append(values, v)
}
return values
}
// GetGetObjectArchivalStateEnumStringValues Enumerates the set of values in String for GetObjectArchivalStateEnum
func GetGetObjectArchivalStateEnumStringValues() []string {
return []string{
"Archived",
"Restoring",
"Restored",
}
}
// GetMappingGetObjectArchivalStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingGetObjectArchivalStateEnum(val string) (GetObjectArchivalStateEnum, bool) {
enum, ok := mappingGetObjectArchivalStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}