-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_objects_request_response.go
128 lines (99 loc) · 5.54 KB
/
list_objects_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
// Copyright (c) 2016, 2018, 2022, 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"
)
// ListObjectsRequest wrapper for the ListObjects operation
//
// See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/objectstorage/ListObjects.go.html to see an example of how to use ListObjectsRequest.
type ListObjectsRequest 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 string to use for matching against the start of object names in a list query.
Prefix *string `mandatory:"false" contributesTo:"query" name:"prefix"`
// Object names returned by a list query must be greater or equal to this parameter.
Start *string `mandatory:"false" contributesTo:"query" name:"start"`
// Object names returned by a list query must be strictly less than this parameter.
End *string `mandatory:"false" contributesTo:"query" name:"end"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// When this parameter is set, only objects whose names do not contain the delimiter character
// (after an optionally specified prefix) are returned in the objects key of the response body.
// Scanned objects whose names contain the delimiter have the part of their name up to the first
// occurrence of the delimiter (including the optional prefix) returned as a set of prefixes.
// Note that only '/' is a supported delimiter character at this time.
Delimiter *string `mandatory:"false" contributesTo:"query" name:"delimiter"`
// Object summary by default includes only the 'name' field. Use this parameter to also
// include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time),
// 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields.
// Specify the value of this parameter as a comma-separated, case-insensitive list of those field names.
// For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
Fields *string `mandatory:"false" contributesTo:"query" name:"fields" omitEmpty:"true"`
// The client request ID for tracing.
OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
// Object names returned by a list query must be greater than this parameter.
StartAfter *string `mandatory:"false" contributesTo:"query" name:"startAfter"`
// 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 ListObjectsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListObjectsRequest) 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 ListObjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListObjectsRequest) 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 ListObjectsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListObjectsResponse wrapper for the ListObjects operation
type ListObjectsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ListObjects instance
ListObjects `presentIn:"body"`
// 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"`
}
func (response ListObjectsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListObjectsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}