/
list_snapshots_request_response.go
148 lines (119 loc) · 6.05 KB
/
list_snapshots_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
// 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 filestorage
import (
"github.com/oracle/oci-go-sdk/common"
"net/http"
)
// ListSnapshotsRequest wrapper for the ListSnapshots operation
type ListSnapshotsRequest struct {
// The OCID of the file system.
FileSystemId *string `mandatory:"true" contributesTo:"query" name:"fileSystemId"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 100 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListSnapshotsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter results by OCID. Must be an OCID of the correct type for
// the resouce type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The sort order to use, either 'asc' or 'desc', where 'asc' is
// ascending and 'desc' is descending. The default order is 'desc'
// except for numeric values.
SortOrder ListSnapshotsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 ListSnapshotsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListSnapshotsRequest) 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 ListSnapshotsRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// ListSnapshotsResponse wrapper for the ListSnapshots operation
type ListSnapshotsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SnapshotSummary instances
Items []SnapshotSummary `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain.
// For important details about how pagination works,
// see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If
// you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSnapshotsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListSnapshotsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListSnapshotsLifecycleStateEnum Enum with underlying type: string
type ListSnapshotsLifecycleStateEnum string
// Set of constants representing the allowable values for ListSnapshotsLifecycleStateEnum
const (
ListSnapshotsLifecycleStateCreating ListSnapshotsLifecycleStateEnum = "CREATING"
ListSnapshotsLifecycleStateActive ListSnapshotsLifecycleStateEnum = "ACTIVE"
ListSnapshotsLifecycleStateDeleting ListSnapshotsLifecycleStateEnum = "DELETING"
ListSnapshotsLifecycleStateDeleted ListSnapshotsLifecycleStateEnum = "DELETED"
ListSnapshotsLifecycleStateFailed ListSnapshotsLifecycleStateEnum = "FAILED"
)
var mappingListSnapshotsLifecycleState = map[string]ListSnapshotsLifecycleStateEnum{
"CREATING": ListSnapshotsLifecycleStateCreating,
"ACTIVE": ListSnapshotsLifecycleStateActive,
"DELETING": ListSnapshotsLifecycleStateDeleting,
"DELETED": ListSnapshotsLifecycleStateDeleted,
"FAILED": ListSnapshotsLifecycleStateFailed,
}
// GetListSnapshotsLifecycleStateEnumValues Enumerates the set of values for ListSnapshotsLifecycleStateEnum
func GetListSnapshotsLifecycleStateEnumValues() []ListSnapshotsLifecycleStateEnum {
values := make([]ListSnapshotsLifecycleStateEnum, 0)
for _, v := range mappingListSnapshotsLifecycleState {
values = append(values, v)
}
return values
}
// ListSnapshotsSortOrderEnum Enum with underlying type: string
type ListSnapshotsSortOrderEnum string
// Set of constants representing the allowable values for ListSnapshotsSortOrderEnum
const (
ListSnapshotsSortOrderAsc ListSnapshotsSortOrderEnum = "ASC"
ListSnapshotsSortOrderDesc ListSnapshotsSortOrderEnum = "DESC"
)
var mappingListSnapshotsSortOrder = map[string]ListSnapshotsSortOrderEnum{
"ASC": ListSnapshotsSortOrderAsc,
"DESC": ListSnapshotsSortOrderDesc,
}
// GetListSnapshotsSortOrderEnumValues Enumerates the set of values for ListSnapshotsSortOrderEnum
func GetListSnapshotsSortOrderEnumValues() []ListSnapshotsSortOrderEnum {
values := make([]ListSnapshotsSortOrderEnum, 0)
for _, v := range mappingListSnapshotsSortOrder {
values = append(values, v)
}
return values
}