1// Copyright (c) 2016, 2018, 2019, Oracle and/or its affiliates. All rights reserved.
2// Code generated. DO NOT EDIT.
3
4package objectstorage
5
6import (
7	"github.com/oracle/oci-go-sdk/common"
8	"net/http"
9)
10
11// ListObjectsRequest wrapper for the ListObjects operation
12type ListObjectsRequest struct {
13
14	// The Object Storage namespace used for the request.
15	NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
16
17	// The name of the bucket. Avoid entering confidential information.
18	// Example: `my-new-bucket1`
19	BucketName *string `mandatory:"true" contributesTo:"path" name:"bucketName"`
20
21	// The string to use for matching against the start of object names in a list query.
22	Prefix *string `mandatory:"false" contributesTo:"query" name:"prefix"`
23
24	// Object names returned by a list query must be greater or equal to this parameter.
25	Start *string `mandatory:"false" contributesTo:"query" name:"start"`
26
27	// Object names returned by a list query must be strictly less than this parameter.
28	End *string `mandatory:"false" contributesTo:"query" name:"end"`
29
30	// The maximum number of items to return.
31	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
32
33	// When this parameter is set, only objects whose names do not contain the delimiter character
34	// (after an optionally specified prefix) are returned in the objects key of the response body.
35	// Scanned objects whose names contain the delimiter have the part of their name up to the first
36	// occurrence of the delimiter (including the optional prefix) returned as a set of prefixes.
37	// Note that only '/' is a supported delimiter character at this time.
38	Delimiter *string `mandatory:"false" contributesTo:"query" name:"delimiter"`
39
40	// Object summary in list of objects includes the 'name' field. This parameter can also include 'size'
41	// (object size in bytes), 'md5', and 'timeCreated' (object creation date and time) fields.
42	// Value of this parameter should be a comma-separated, case-insensitive list of those field names.
43	// For example 'name,timeCreated,md5'.
44	Fields *string `mandatory:"false" contributesTo:"query" name:"fields" omitEmpty:"true"`
45
46	// The client request ID for tracing.
47	OpcClientRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-client-request-id"`
48
49	// Metadata about the request. This information will not be transmitted to the service, but
50	// represents information that the SDK will consume to drive retry behavior.
51	RequestMetadata common.RequestMetadata
52}
53
54func (request ListObjectsRequest) String() string {
55	return common.PointerString(request)
56}
57
58// HTTPRequest implements the OCIRequest interface
59func (request ListObjectsRequest) HTTPRequest(method, path string) (http.Request, error) {
60	return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
61}
62
63// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
64func (request ListObjectsRequest) RetryPolicy() *common.RetryPolicy {
65	return request.RequestMetadata.RetryPolicy
66}
67
68// ListObjectsResponse wrapper for the ListObjects operation
69type ListObjectsResponse struct {
70
71	// The underlying http response
72	RawResponse *http.Response
73
74	// The ListObjects instance
75	ListObjects `presentIn:"body"`
76
77	// Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
78	OpcClientRequestId *string `presentIn:"header" name:"opc-client-request-id"`
79
80	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
81	// request, provide this request ID.
82	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
83}
84
85func (response ListObjectsResponse) String() string {
86	return common.PointerString(response)
87}
88
89// HTTPResponse implements the OCIResponse interface
90func (response ListObjectsResponse) HTTPResponse() *http.Response {
91	return response.RawResponse
92}
93