/
list_dr_protection_groups_request_response.go
384 lines (319 loc) · 18.2 KB
/
list_dr_protection_groups_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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
// 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 disasterrecovery
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListDrProtectionGroupsRequest wrapper for the ListDrProtectionGroups operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrProtectionGroups.go.html to see an example of how to use ListDrProtectionGroupsRequest.
type ListDrProtectionGroupsRequest struct {
// The ID (OCID) of the compartment in which to list resources.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only DR protection groups that match the given lifecycle state.
LifecycleState ListDrProtectionGroupsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID of the DR protection group. Optional query param.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"false" contributesTo:"query" name:"drProtectionGroupId"`
// A filter to return only resources that match the given display name.
// Example: `MyResourceDisplayName`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 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"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDrProtectionGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
// Default order for displayName is ascending. If no value is specified timeCreated is default.
// Example: `MyResourceDisplayName`
SortBy ListDrProtectionGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The DR protection group Role.
Role ListDrProtectionGroupsRoleEnum `mandatory:"false" contributesTo:"query" name:"role" omitEmpty:"true"`
// A filter to return only DR protection groups that match the given lifecycle sub-state.
LifecycleSubState ListDrProtectionGroupsLifecycleSubStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleSubState" 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 ListDrProtectionGroupsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListDrProtectionGroupsRequest) 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 ListDrProtectionGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDrProtectionGroupsRequest) 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 ListDrProtectionGroupsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListDrProtectionGroupsLifecycleStateEnum(string(request.LifecycleState)); !ok && request.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", request.LifecycleState, strings.Join(GetListDrProtectionGroupsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListDrProtectionGroupsSortOrderEnum(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(GetListDrProtectionGroupsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListDrProtectionGroupsSortByEnum(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(GetListDrProtectionGroupsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListDrProtectionGroupsRoleEnum(string(request.Role)); !ok && request.Role != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Role: %s. Supported values are: %s.", request.Role, strings.Join(GetListDrProtectionGroupsRoleEnumStringValues(), ",")))
}
if _, ok := GetMappingListDrProtectionGroupsLifecycleSubStateEnum(string(request.LifecycleSubState)); !ok && request.LifecycleSubState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleSubState: %s. Supported values are: %s.", request.LifecycleSubState, strings.Join(GetListDrProtectionGroupsLifecycleSubStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListDrProtectionGroupsResponse wrapper for the ListDrProtectionGroups operation
type ListDrProtectionGroupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DrProtectionGroupCollection instances
DrProtectionGroupCollection `presentIn:"body"`
// 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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDrProtectionGroupsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListDrProtectionGroupsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListDrProtectionGroupsLifecycleStateEnum Enum with underlying type: string
type ListDrProtectionGroupsLifecycleStateEnum string
// Set of constants representing the allowable values for ListDrProtectionGroupsLifecycleStateEnum
const (
ListDrProtectionGroupsLifecycleStateCreating ListDrProtectionGroupsLifecycleStateEnum = "CREATING"
ListDrProtectionGroupsLifecycleStateActive ListDrProtectionGroupsLifecycleStateEnum = "ACTIVE"
ListDrProtectionGroupsLifecycleStateUpdating ListDrProtectionGroupsLifecycleStateEnum = "UPDATING"
ListDrProtectionGroupsLifecycleStateInactive ListDrProtectionGroupsLifecycleStateEnum = "INACTIVE"
ListDrProtectionGroupsLifecycleStateNeedsAttention ListDrProtectionGroupsLifecycleStateEnum = "NEEDS_ATTENTION"
ListDrProtectionGroupsLifecycleStateDeleting ListDrProtectionGroupsLifecycleStateEnum = "DELETING"
ListDrProtectionGroupsLifecycleStateDeleted ListDrProtectionGroupsLifecycleStateEnum = "DELETED"
ListDrProtectionGroupsLifecycleStateFailed ListDrProtectionGroupsLifecycleStateEnum = "FAILED"
)
var mappingListDrProtectionGroupsLifecycleStateEnum = map[string]ListDrProtectionGroupsLifecycleStateEnum{
"CREATING": ListDrProtectionGroupsLifecycleStateCreating,
"ACTIVE": ListDrProtectionGroupsLifecycleStateActive,
"UPDATING": ListDrProtectionGroupsLifecycleStateUpdating,
"INACTIVE": ListDrProtectionGroupsLifecycleStateInactive,
"NEEDS_ATTENTION": ListDrProtectionGroupsLifecycleStateNeedsAttention,
"DELETING": ListDrProtectionGroupsLifecycleStateDeleting,
"DELETED": ListDrProtectionGroupsLifecycleStateDeleted,
"FAILED": ListDrProtectionGroupsLifecycleStateFailed,
}
var mappingListDrProtectionGroupsLifecycleStateEnumLowerCase = map[string]ListDrProtectionGroupsLifecycleStateEnum{
"creating": ListDrProtectionGroupsLifecycleStateCreating,
"active": ListDrProtectionGroupsLifecycleStateActive,
"updating": ListDrProtectionGroupsLifecycleStateUpdating,
"inactive": ListDrProtectionGroupsLifecycleStateInactive,
"needs_attention": ListDrProtectionGroupsLifecycleStateNeedsAttention,
"deleting": ListDrProtectionGroupsLifecycleStateDeleting,
"deleted": ListDrProtectionGroupsLifecycleStateDeleted,
"failed": ListDrProtectionGroupsLifecycleStateFailed,
}
// GetListDrProtectionGroupsLifecycleStateEnumValues Enumerates the set of values for ListDrProtectionGroupsLifecycleStateEnum
func GetListDrProtectionGroupsLifecycleStateEnumValues() []ListDrProtectionGroupsLifecycleStateEnum {
values := make([]ListDrProtectionGroupsLifecycleStateEnum, 0)
for _, v := range mappingListDrProtectionGroupsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListDrProtectionGroupsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsLifecycleStateEnum
func GetListDrProtectionGroupsLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"ACTIVE",
"UPDATING",
"INACTIVE",
"NEEDS_ATTENTION",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingListDrProtectionGroupsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDrProtectionGroupsLifecycleStateEnum(val string) (ListDrProtectionGroupsLifecycleStateEnum, bool) {
enum, ok := mappingListDrProtectionGroupsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDrProtectionGroupsSortOrderEnum Enum with underlying type: string
type ListDrProtectionGroupsSortOrderEnum string
// Set of constants representing the allowable values for ListDrProtectionGroupsSortOrderEnum
const (
ListDrProtectionGroupsSortOrderAsc ListDrProtectionGroupsSortOrderEnum = "ASC"
ListDrProtectionGroupsSortOrderDesc ListDrProtectionGroupsSortOrderEnum = "DESC"
)
var mappingListDrProtectionGroupsSortOrderEnum = map[string]ListDrProtectionGroupsSortOrderEnum{
"ASC": ListDrProtectionGroupsSortOrderAsc,
"DESC": ListDrProtectionGroupsSortOrderDesc,
}
var mappingListDrProtectionGroupsSortOrderEnumLowerCase = map[string]ListDrProtectionGroupsSortOrderEnum{
"asc": ListDrProtectionGroupsSortOrderAsc,
"desc": ListDrProtectionGroupsSortOrderDesc,
}
// GetListDrProtectionGroupsSortOrderEnumValues Enumerates the set of values for ListDrProtectionGroupsSortOrderEnum
func GetListDrProtectionGroupsSortOrderEnumValues() []ListDrProtectionGroupsSortOrderEnum {
values := make([]ListDrProtectionGroupsSortOrderEnum, 0)
for _, v := range mappingListDrProtectionGroupsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListDrProtectionGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsSortOrderEnum
func GetListDrProtectionGroupsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListDrProtectionGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDrProtectionGroupsSortOrderEnum(val string) (ListDrProtectionGroupsSortOrderEnum, bool) {
enum, ok := mappingListDrProtectionGroupsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDrProtectionGroupsSortByEnum Enum with underlying type: string
type ListDrProtectionGroupsSortByEnum string
// Set of constants representing the allowable values for ListDrProtectionGroupsSortByEnum
const (
ListDrProtectionGroupsSortByTimecreated ListDrProtectionGroupsSortByEnum = "timeCreated"
ListDrProtectionGroupsSortByDisplayname ListDrProtectionGroupsSortByEnum = "displayName"
)
var mappingListDrProtectionGroupsSortByEnum = map[string]ListDrProtectionGroupsSortByEnum{
"timeCreated": ListDrProtectionGroupsSortByTimecreated,
"displayName": ListDrProtectionGroupsSortByDisplayname,
}
var mappingListDrProtectionGroupsSortByEnumLowerCase = map[string]ListDrProtectionGroupsSortByEnum{
"timecreated": ListDrProtectionGroupsSortByTimecreated,
"displayname": ListDrProtectionGroupsSortByDisplayname,
}
// GetListDrProtectionGroupsSortByEnumValues Enumerates the set of values for ListDrProtectionGroupsSortByEnum
func GetListDrProtectionGroupsSortByEnumValues() []ListDrProtectionGroupsSortByEnum {
values := make([]ListDrProtectionGroupsSortByEnum, 0)
for _, v := range mappingListDrProtectionGroupsSortByEnum {
values = append(values, v)
}
return values
}
// GetListDrProtectionGroupsSortByEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsSortByEnum
func GetListDrProtectionGroupsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListDrProtectionGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDrProtectionGroupsSortByEnum(val string) (ListDrProtectionGroupsSortByEnum, bool) {
enum, ok := mappingListDrProtectionGroupsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDrProtectionGroupsRoleEnum Enum with underlying type: string
type ListDrProtectionGroupsRoleEnum string
// Set of constants representing the allowable values for ListDrProtectionGroupsRoleEnum
const (
ListDrProtectionGroupsRolePrimary ListDrProtectionGroupsRoleEnum = "PRIMARY"
ListDrProtectionGroupsRoleStandby ListDrProtectionGroupsRoleEnum = "STANDBY"
ListDrProtectionGroupsRoleUnconfigured ListDrProtectionGroupsRoleEnum = "UNCONFIGURED"
)
var mappingListDrProtectionGroupsRoleEnum = map[string]ListDrProtectionGroupsRoleEnum{
"PRIMARY": ListDrProtectionGroupsRolePrimary,
"STANDBY": ListDrProtectionGroupsRoleStandby,
"UNCONFIGURED": ListDrProtectionGroupsRoleUnconfigured,
}
var mappingListDrProtectionGroupsRoleEnumLowerCase = map[string]ListDrProtectionGroupsRoleEnum{
"primary": ListDrProtectionGroupsRolePrimary,
"standby": ListDrProtectionGroupsRoleStandby,
"unconfigured": ListDrProtectionGroupsRoleUnconfigured,
}
// GetListDrProtectionGroupsRoleEnumValues Enumerates the set of values for ListDrProtectionGroupsRoleEnum
func GetListDrProtectionGroupsRoleEnumValues() []ListDrProtectionGroupsRoleEnum {
values := make([]ListDrProtectionGroupsRoleEnum, 0)
for _, v := range mappingListDrProtectionGroupsRoleEnum {
values = append(values, v)
}
return values
}
// GetListDrProtectionGroupsRoleEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsRoleEnum
func GetListDrProtectionGroupsRoleEnumStringValues() []string {
return []string{
"PRIMARY",
"STANDBY",
"UNCONFIGURED",
}
}
// GetMappingListDrProtectionGroupsRoleEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDrProtectionGroupsRoleEnum(val string) (ListDrProtectionGroupsRoleEnum, bool) {
enum, ok := mappingListDrProtectionGroupsRoleEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDrProtectionGroupsLifecycleSubStateEnum Enum with underlying type: string
type ListDrProtectionGroupsLifecycleSubStateEnum string
// Set of constants representing the allowable values for ListDrProtectionGroupsLifecycleSubStateEnum
const (
ListDrProtectionGroupsLifecycleSubStateDrDrillInProgress ListDrProtectionGroupsLifecycleSubStateEnum = "DR_DRILL_IN_PROGRESS"
)
var mappingListDrProtectionGroupsLifecycleSubStateEnum = map[string]ListDrProtectionGroupsLifecycleSubStateEnum{
"DR_DRILL_IN_PROGRESS": ListDrProtectionGroupsLifecycleSubStateDrDrillInProgress,
}
var mappingListDrProtectionGroupsLifecycleSubStateEnumLowerCase = map[string]ListDrProtectionGroupsLifecycleSubStateEnum{
"dr_drill_in_progress": ListDrProtectionGroupsLifecycleSubStateDrDrillInProgress,
}
// GetListDrProtectionGroupsLifecycleSubStateEnumValues Enumerates the set of values for ListDrProtectionGroupsLifecycleSubStateEnum
func GetListDrProtectionGroupsLifecycleSubStateEnumValues() []ListDrProtectionGroupsLifecycleSubStateEnum {
values := make([]ListDrProtectionGroupsLifecycleSubStateEnum, 0)
for _, v := range mappingListDrProtectionGroupsLifecycleSubStateEnum {
values = append(values, v)
}
return values
}
// GetListDrProtectionGroupsLifecycleSubStateEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsLifecycleSubStateEnum
func GetListDrProtectionGroupsLifecycleSubStateEnumStringValues() []string {
return []string{
"DR_DRILL_IN_PROGRESS",
}
}
// GetMappingListDrProtectionGroupsLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDrProtectionGroupsLifecycleSubStateEnum(val string) (ListDrProtectionGroupsLifecycleSubStateEnum, bool) {
enum, ok := mappingListDrProtectionGroupsLifecycleSubStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}