-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_vb_instances_request_response.go
273 lines (224 loc) · 11.4 KB
/
list_vb_instances_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
// Copyright (c) 2016, 2018, 2023, 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 visualbuilder
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListVbInstancesRequest wrapper for the ListVbInstances operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/visualbuilder/ListVbInstances.go.html to see an example of how to use ListVbInstancesRequest.
type ListVbInstancesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Life cycle state to query on.
LifecycleState ListVbInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListVbInstancesSortOrderEnum `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.
SortBy ListVbInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
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 ListVbInstancesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListVbInstancesRequest) 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 ListVbInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVbInstancesRequest) 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 ListVbInstancesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListVbInstancesLifecycleStateEnum(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(GetListVbInstancesLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListVbInstancesSortOrderEnum(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(GetListVbInstancesSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListVbInstancesSortByEnum(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(GetListVbInstancesSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListVbInstancesResponse wrapper for the ListVbInstances operation
type ListVbInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VbInstanceSummaryCollection instances
VbInstanceSummaryCollection `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 list pagination. When this header appears in the response, additional pages of results remain
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, additional pages of results have been previously returned
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListVbInstancesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListVbInstancesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListVbInstancesLifecycleStateEnum Enum with underlying type: string
type ListVbInstancesLifecycleStateEnum string
// Set of constants representing the allowable values for ListVbInstancesLifecycleStateEnum
const (
ListVbInstancesLifecycleStateCreating ListVbInstancesLifecycleStateEnum = "CREATING"
ListVbInstancesLifecycleStateUpdating ListVbInstancesLifecycleStateEnum = "UPDATING"
ListVbInstancesLifecycleStateActive ListVbInstancesLifecycleStateEnum = "ACTIVE"
ListVbInstancesLifecycleStateInactive ListVbInstancesLifecycleStateEnum = "INACTIVE"
ListVbInstancesLifecycleStateDeleting ListVbInstancesLifecycleStateEnum = "DELETING"
ListVbInstancesLifecycleStateDeleted ListVbInstancesLifecycleStateEnum = "DELETED"
ListVbInstancesLifecycleStateFailed ListVbInstancesLifecycleStateEnum = "FAILED"
)
var mappingListVbInstancesLifecycleStateEnum = map[string]ListVbInstancesLifecycleStateEnum{
"CREATING": ListVbInstancesLifecycleStateCreating,
"UPDATING": ListVbInstancesLifecycleStateUpdating,
"ACTIVE": ListVbInstancesLifecycleStateActive,
"INACTIVE": ListVbInstancesLifecycleStateInactive,
"DELETING": ListVbInstancesLifecycleStateDeleting,
"DELETED": ListVbInstancesLifecycleStateDeleted,
"FAILED": ListVbInstancesLifecycleStateFailed,
}
var mappingListVbInstancesLifecycleStateEnumLowerCase = map[string]ListVbInstancesLifecycleStateEnum{
"creating": ListVbInstancesLifecycleStateCreating,
"updating": ListVbInstancesLifecycleStateUpdating,
"active": ListVbInstancesLifecycleStateActive,
"inactive": ListVbInstancesLifecycleStateInactive,
"deleting": ListVbInstancesLifecycleStateDeleting,
"deleted": ListVbInstancesLifecycleStateDeleted,
"failed": ListVbInstancesLifecycleStateFailed,
}
// GetListVbInstancesLifecycleStateEnumValues Enumerates the set of values for ListVbInstancesLifecycleStateEnum
func GetListVbInstancesLifecycleStateEnumValues() []ListVbInstancesLifecycleStateEnum {
values := make([]ListVbInstancesLifecycleStateEnum, 0)
for _, v := range mappingListVbInstancesLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListVbInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListVbInstancesLifecycleStateEnum
func GetListVbInstancesLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"UPDATING",
"ACTIVE",
"INACTIVE",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingListVbInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVbInstancesLifecycleStateEnum(val string) (ListVbInstancesLifecycleStateEnum, bool) {
enum, ok := mappingListVbInstancesLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListVbInstancesSortOrderEnum Enum with underlying type: string
type ListVbInstancesSortOrderEnum string
// Set of constants representing the allowable values for ListVbInstancesSortOrderEnum
const (
ListVbInstancesSortOrderAsc ListVbInstancesSortOrderEnum = "ASC"
ListVbInstancesSortOrderDesc ListVbInstancesSortOrderEnum = "DESC"
)
var mappingListVbInstancesSortOrderEnum = map[string]ListVbInstancesSortOrderEnum{
"ASC": ListVbInstancesSortOrderAsc,
"DESC": ListVbInstancesSortOrderDesc,
}
var mappingListVbInstancesSortOrderEnumLowerCase = map[string]ListVbInstancesSortOrderEnum{
"asc": ListVbInstancesSortOrderAsc,
"desc": ListVbInstancesSortOrderDesc,
}
// GetListVbInstancesSortOrderEnumValues Enumerates the set of values for ListVbInstancesSortOrderEnum
func GetListVbInstancesSortOrderEnumValues() []ListVbInstancesSortOrderEnum {
values := make([]ListVbInstancesSortOrderEnum, 0)
for _, v := range mappingListVbInstancesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListVbInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListVbInstancesSortOrderEnum
func GetListVbInstancesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListVbInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVbInstancesSortOrderEnum(val string) (ListVbInstancesSortOrderEnum, bool) {
enum, ok := mappingListVbInstancesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListVbInstancesSortByEnum Enum with underlying type: string
type ListVbInstancesSortByEnum string
// Set of constants representing the allowable values for ListVbInstancesSortByEnum
const (
ListVbInstancesSortByTimecreated ListVbInstancesSortByEnum = "timeCreated"
ListVbInstancesSortByDisplayname ListVbInstancesSortByEnum = "displayName"
)
var mappingListVbInstancesSortByEnum = map[string]ListVbInstancesSortByEnum{
"timeCreated": ListVbInstancesSortByTimecreated,
"displayName": ListVbInstancesSortByDisplayname,
}
var mappingListVbInstancesSortByEnumLowerCase = map[string]ListVbInstancesSortByEnum{
"timecreated": ListVbInstancesSortByTimecreated,
"displayname": ListVbInstancesSortByDisplayname,
}
// GetListVbInstancesSortByEnumValues Enumerates the set of values for ListVbInstancesSortByEnum
func GetListVbInstancesSortByEnumValues() []ListVbInstancesSortByEnum {
values := make([]ListVbInstancesSortByEnum, 0)
for _, v := range mappingListVbInstancesSortByEnum {
values = append(values, v)
}
return values
}
// GetListVbInstancesSortByEnumStringValues Enumerates the set of values in String for ListVbInstancesSortByEnum
func GetListVbInstancesSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListVbInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVbInstancesSortByEnum(val string) (ListVbInstancesSortByEnum, bool) {
enum, ok := mappingListVbInstancesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}