-
Notifications
You must be signed in to change notification settings - Fork 82
/
head_object_request_response.go
308 lines (249 loc) · 13.4 KB
/
head_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
// 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"
"net/http"
"strings"
)
// HeadObjectRequest wrapper for the HeadObject operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/HeadObject.go.html to see an example of how to use HeadObjectRequest.
type HeadObjectRequest 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"`
// 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 HeadObjectRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request HeadObjectRequest) 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 HeadObjectRequest) 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 HeadObjectRequest) 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 HeadObjectRequest) 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 HeadObjectRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// HeadObjectResponse wrapper for the HeadObject operation
type HeadObjectResponse struct {
// The underlying http response
RawResponse *http.Response
// 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-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 HeadObjectStorageTierEnum `presentIn:"header" name:"storage-tier"`
// Archival state of an object. This field is set only for objects in Archive tier.
ArchivalState HeadObjectArchivalStateEnum `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 HeadObjectResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response HeadObjectResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// HeadObjectStorageTierEnum Enum with underlying type: string
type HeadObjectStorageTierEnum string
// Set of constants representing the allowable values for HeadObjectStorageTierEnum
const (
HeadObjectStorageTierStandard HeadObjectStorageTierEnum = "Standard"
HeadObjectStorageTierInfrequentaccess HeadObjectStorageTierEnum = "InfrequentAccess"
HeadObjectStorageTierArchive HeadObjectStorageTierEnum = "Archive"
)
var mappingHeadObjectStorageTierEnum = map[string]HeadObjectStorageTierEnum{
"Standard": HeadObjectStorageTierStandard,
"InfrequentAccess": HeadObjectStorageTierInfrequentaccess,
"Archive": HeadObjectStorageTierArchive,
}
var mappingHeadObjectStorageTierEnumLowerCase = map[string]HeadObjectStorageTierEnum{
"standard": HeadObjectStorageTierStandard,
"infrequentaccess": HeadObjectStorageTierInfrequentaccess,
"archive": HeadObjectStorageTierArchive,
}
// GetHeadObjectStorageTierEnumValues Enumerates the set of values for HeadObjectStorageTierEnum
func GetHeadObjectStorageTierEnumValues() []HeadObjectStorageTierEnum {
values := make([]HeadObjectStorageTierEnum, 0)
for _, v := range mappingHeadObjectStorageTierEnum {
values = append(values, v)
}
return values
}
// GetHeadObjectStorageTierEnumStringValues Enumerates the set of values in String for HeadObjectStorageTierEnum
func GetHeadObjectStorageTierEnumStringValues() []string {
return []string{
"Standard",
"InfrequentAccess",
"Archive",
}
}
// GetMappingHeadObjectStorageTierEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingHeadObjectStorageTierEnum(val string) (HeadObjectStorageTierEnum, bool) {
enum, ok := mappingHeadObjectStorageTierEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// HeadObjectArchivalStateEnum Enum with underlying type: string
type HeadObjectArchivalStateEnum string
// Set of constants representing the allowable values for HeadObjectArchivalStateEnum
const (
HeadObjectArchivalStateArchived HeadObjectArchivalStateEnum = "Archived"
HeadObjectArchivalStateRestoring HeadObjectArchivalStateEnum = "Restoring"
HeadObjectArchivalStateRestored HeadObjectArchivalStateEnum = "Restored"
)
var mappingHeadObjectArchivalStateEnum = map[string]HeadObjectArchivalStateEnum{
"Archived": HeadObjectArchivalStateArchived,
"Restoring": HeadObjectArchivalStateRestoring,
"Restored": HeadObjectArchivalStateRestored,
}
var mappingHeadObjectArchivalStateEnumLowerCase = map[string]HeadObjectArchivalStateEnum{
"archived": HeadObjectArchivalStateArchived,
"restoring": HeadObjectArchivalStateRestoring,
"restored": HeadObjectArchivalStateRestored,
}
// GetHeadObjectArchivalStateEnumValues Enumerates the set of values for HeadObjectArchivalStateEnum
func GetHeadObjectArchivalStateEnumValues() []HeadObjectArchivalStateEnum {
values := make([]HeadObjectArchivalStateEnum, 0)
for _, v := range mappingHeadObjectArchivalStateEnum {
values = append(values, v)
}
return values
}
// GetHeadObjectArchivalStateEnumStringValues Enumerates the set of values in String for HeadObjectArchivalStateEnum
func GetHeadObjectArchivalStateEnumStringValues() []string {
return []string{
"Archived",
"Restoring",
"Restored",
}
}
// GetMappingHeadObjectArchivalStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingHeadObjectArchivalStateEnum(val string) (HeadObjectArchivalStateEnum, bool) {
enum, ok := mappingHeadObjectArchivalStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}