/
list_vault_replicas_request_response.go
221 lines (179 loc) · 9.29 KB
/
list_vault_replicas_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
// 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 keymanagement
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListVaultReplicasRequest wrapper for the ListVaultReplicas operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListVaultReplicas.go.html to see an example of how to use ListVaultReplicasRequest.
type ListVaultReplicasRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The field to sort by. You can specify only one sort order. The default
// order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
// is ascending.
SortBy ListVaultReplicasSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListVaultReplicasSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListVaultReplicasRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListVaultReplicasRequest) 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 ListVaultReplicasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVaultReplicasRequest) 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 ListVaultReplicasRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListVaultReplicasSortByEnum(string(request.SortBy)); !ok && request.SortBy != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SortBy: %s. Supported values are: %s.", request.SortBy, strings.Join(GetListVaultReplicasSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListVaultReplicasSortOrderEnum(string(request.SortOrder)); !ok && request.SortOrder != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SortOrder: %s. Supported values are: %s.", request.SortOrder, strings.Join(GetListVaultReplicasSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListVaultReplicasResponse wrapper for the ListVaultReplicas operation
type ListVaultReplicasResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VaultReplicaSummary instances
Items []VaultReplicaSummary `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there are additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.com/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 ListVaultReplicasResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListVaultReplicasResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListVaultReplicasSortByEnum Enum with underlying type: string
type ListVaultReplicasSortByEnum string
// Set of constants representing the allowable values for ListVaultReplicasSortByEnum
const (
ListVaultReplicasSortByTimecreated ListVaultReplicasSortByEnum = "TIMECREATED"
ListVaultReplicasSortByDisplayname ListVaultReplicasSortByEnum = "DISPLAYNAME"
)
var mappingListVaultReplicasSortByEnum = map[string]ListVaultReplicasSortByEnum{
"TIMECREATED": ListVaultReplicasSortByTimecreated,
"DISPLAYNAME": ListVaultReplicasSortByDisplayname,
}
var mappingListVaultReplicasSortByEnumLowerCase = map[string]ListVaultReplicasSortByEnum{
"timecreated": ListVaultReplicasSortByTimecreated,
"displayname": ListVaultReplicasSortByDisplayname,
}
// GetListVaultReplicasSortByEnumValues Enumerates the set of values for ListVaultReplicasSortByEnum
func GetListVaultReplicasSortByEnumValues() []ListVaultReplicasSortByEnum {
values := make([]ListVaultReplicasSortByEnum, 0)
for _, v := range mappingListVaultReplicasSortByEnum {
values = append(values, v)
}
return values
}
// GetListVaultReplicasSortByEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortByEnum
func GetListVaultReplicasSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
}
}
// GetMappingListVaultReplicasSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVaultReplicasSortByEnum(val string) (ListVaultReplicasSortByEnum, bool) {
enum, ok := mappingListVaultReplicasSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListVaultReplicasSortOrderEnum Enum with underlying type: string
type ListVaultReplicasSortOrderEnum string
// Set of constants representing the allowable values for ListVaultReplicasSortOrderEnum
const (
ListVaultReplicasSortOrderAsc ListVaultReplicasSortOrderEnum = "ASC"
ListVaultReplicasSortOrderDesc ListVaultReplicasSortOrderEnum = "DESC"
)
var mappingListVaultReplicasSortOrderEnum = map[string]ListVaultReplicasSortOrderEnum{
"ASC": ListVaultReplicasSortOrderAsc,
"DESC": ListVaultReplicasSortOrderDesc,
}
var mappingListVaultReplicasSortOrderEnumLowerCase = map[string]ListVaultReplicasSortOrderEnum{
"asc": ListVaultReplicasSortOrderAsc,
"desc": ListVaultReplicasSortOrderDesc,
}
// GetListVaultReplicasSortOrderEnumValues Enumerates the set of values for ListVaultReplicasSortOrderEnum
func GetListVaultReplicasSortOrderEnumValues() []ListVaultReplicasSortOrderEnum {
values := make([]ListVaultReplicasSortOrderEnum, 0)
for _, v := range mappingListVaultReplicasSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListVaultReplicasSortOrderEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortOrderEnum
func GetListVaultReplicasSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListVaultReplicasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVaultReplicasSortOrderEnum(val string) (ListVaultReplicasSortOrderEnum, bool) {
enum, ok := mappingListVaultReplicasSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}