-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_analytics_instances_request_response.go
390 lines (326 loc) · 18.5 KB
/
list_analytics_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
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
385
386
387
388
389
390
// 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 analytics
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAnalyticsInstancesRequest wrapper for the ListAnalyticsInstances operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListAnalyticsInstances.go.html to see an example of how to use ListAnalyticsInstancesRequest.
type ListAnalyticsInstancesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// A filter to return only resources that match the given name exactly.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to only return resources matching the capacity type enum. Values are
// case-insensitive.
CapacityType ListAnalyticsInstancesCapacityTypeEnum `mandatory:"false" contributesTo:"query" name:"capacityType" omitEmpty:"true"`
// A filter to only return resources matching the feature set. Values are
// case-insensitive.
FeatureSet ListAnalyticsInstancesFeatureSetEnum `mandatory:"false" contributesTo:"query" name:"featureSet" omitEmpty:"true"`
// A filter to only return resources matching the lifecycle state. The state
// value is case-insensitive.
LifecycleState ListAnalyticsInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
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 field to sort by (one column only). Default sort order is
// ascending exception of `timeCreated` column (descending).
SortBy ListAnalyticsInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListAnalyticsInstancesSortOrderEnum `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 ListAnalyticsInstancesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAnalyticsInstancesRequest) 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 ListAnalyticsInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnalyticsInstancesRequest) 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 ListAnalyticsInstancesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAnalyticsInstancesCapacityTypeEnum(string(request.CapacityType)); !ok && request.CapacityType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for CapacityType: %s. Supported values are: %s.", request.CapacityType, strings.Join(GetListAnalyticsInstancesCapacityTypeEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnalyticsInstancesFeatureSetEnum(string(request.FeatureSet)); !ok && request.FeatureSet != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for FeatureSet: %s. Supported values are: %s.", request.FeatureSet, strings.Join(GetListAnalyticsInstancesFeatureSetEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnalyticsInstancesLifecycleStateEnum(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(GetListAnalyticsInstancesLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnalyticsInstancesSortByEnum(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(GetListAnalyticsInstancesSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnalyticsInstancesSortOrderEnum(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(GetListAnalyticsInstancesSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAnalyticsInstancesResponse wrapper for the ListAnalyticsInstances operation
type ListAnalyticsInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AnalyticsInstanceSummary instances
Items []AnalyticsInstanceSummary `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 ListAnalyticsInstancesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAnalyticsInstancesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAnalyticsInstancesCapacityTypeEnum Enum with underlying type: string
type ListAnalyticsInstancesCapacityTypeEnum string
// Set of constants representing the allowable values for ListAnalyticsInstancesCapacityTypeEnum
const (
ListAnalyticsInstancesCapacityTypeOlpuCount ListAnalyticsInstancesCapacityTypeEnum = "OLPU_COUNT"
ListAnalyticsInstancesCapacityTypeUserCount ListAnalyticsInstancesCapacityTypeEnum = "USER_COUNT"
)
var mappingListAnalyticsInstancesCapacityTypeEnum = map[string]ListAnalyticsInstancesCapacityTypeEnum{
"OLPU_COUNT": ListAnalyticsInstancesCapacityTypeOlpuCount,
"USER_COUNT": ListAnalyticsInstancesCapacityTypeUserCount,
}
var mappingListAnalyticsInstancesCapacityTypeEnumLowerCase = map[string]ListAnalyticsInstancesCapacityTypeEnum{
"olpu_count": ListAnalyticsInstancesCapacityTypeOlpuCount,
"user_count": ListAnalyticsInstancesCapacityTypeUserCount,
}
// GetListAnalyticsInstancesCapacityTypeEnumValues Enumerates the set of values for ListAnalyticsInstancesCapacityTypeEnum
func GetListAnalyticsInstancesCapacityTypeEnumValues() []ListAnalyticsInstancesCapacityTypeEnum {
values := make([]ListAnalyticsInstancesCapacityTypeEnum, 0)
for _, v := range mappingListAnalyticsInstancesCapacityTypeEnum {
values = append(values, v)
}
return values
}
// GetListAnalyticsInstancesCapacityTypeEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesCapacityTypeEnum
func GetListAnalyticsInstancesCapacityTypeEnumStringValues() []string {
return []string{
"OLPU_COUNT",
"USER_COUNT",
}
}
// GetMappingListAnalyticsInstancesCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnalyticsInstancesCapacityTypeEnum(val string) (ListAnalyticsInstancesCapacityTypeEnum, bool) {
enum, ok := mappingListAnalyticsInstancesCapacityTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnalyticsInstancesFeatureSetEnum Enum with underlying type: string
type ListAnalyticsInstancesFeatureSetEnum string
// Set of constants representing the allowable values for ListAnalyticsInstancesFeatureSetEnum
const (
ListAnalyticsInstancesFeatureSetSelfServiceAnalytics ListAnalyticsInstancesFeatureSetEnum = "SELF_SERVICE_ANALYTICS"
ListAnalyticsInstancesFeatureSetEnterpriseAnalytics ListAnalyticsInstancesFeatureSetEnum = "ENTERPRISE_ANALYTICS"
)
var mappingListAnalyticsInstancesFeatureSetEnum = map[string]ListAnalyticsInstancesFeatureSetEnum{
"SELF_SERVICE_ANALYTICS": ListAnalyticsInstancesFeatureSetSelfServiceAnalytics,
"ENTERPRISE_ANALYTICS": ListAnalyticsInstancesFeatureSetEnterpriseAnalytics,
}
var mappingListAnalyticsInstancesFeatureSetEnumLowerCase = map[string]ListAnalyticsInstancesFeatureSetEnum{
"self_service_analytics": ListAnalyticsInstancesFeatureSetSelfServiceAnalytics,
"enterprise_analytics": ListAnalyticsInstancesFeatureSetEnterpriseAnalytics,
}
// GetListAnalyticsInstancesFeatureSetEnumValues Enumerates the set of values for ListAnalyticsInstancesFeatureSetEnum
func GetListAnalyticsInstancesFeatureSetEnumValues() []ListAnalyticsInstancesFeatureSetEnum {
values := make([]ListAnalyticsInstancesFeatureSetEnum, 0)
for _, v := range mappingListAnalyticsInstancesFeatureSetEnum {
values = append(values, v)
}
return values
}
// GetListAnalyticsInstancesFeatureSetEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesFeatureSetEnum
func GetListAnalyticsInstancesFeatureSetEnumStringValues() []string {
return []string{
"SELF_SERVICE_ANALYTICS",
"ENTERPRISE_ANALYTICS",
}
}
// GetMappingListAnalyticsInstancesFeatureSetEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnalyticsInstancesFeatureSetEnum(val string) (ListAnalyticsInstancesFeatureSetEnum, bool) {
enum, ok := mappingListAnalyticsInstancesFeatureSetEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnalyticsInstancesLifecycleStateEnum Enum with underlying type: string
type ListAnalyticsInstancesLifecycleStateEnum string
// Set of constants representing the allowable values for ListAnalyticsInstancesLifecycleStateEnum
const (
ListAnalyticsInstancesLifecycleStateActive ListAnalyticsInstancesLifecycleStateEnum = "ACTIVE"
ListAnalyticsInstancesLifecycleStateCreating ListAnalyticsInstancesLifecycleStateEnum = "CREATING"
ListAnalyticsInstancesLifecycleStateDeleted ListAnalyticsInstancesLifecycleStateEnum = "DELETED"
ListAnalyticsInstancesLifecycleStateDeleting ListAnalyticsInstancesLifecycleStateEnum = "DELETING"
ListAnalyticsInstancesLifecycleStateFailed ListAnalyticsInstancesLifecycleStateEnum = "FAILED"
ListAnalyticsInstancesLifecycleStateInactive ListAnalyticsInstancesLifecycleStateEnum = "INACTIVE"
ListAnalyticsInstancesLifecycleStateUpdating ListAnalyticsInstancesLifecycleStateEnum = "UPDATING"
)
var mappingListAnalyticsInstancesLifecycleStateEnum = map[string]ListAnalyticsInstancesLifecycleStateEnum{
"ACTIVE": ListAnalyticsInstancesLifecycleStateActive,
"CREATING": ListAnalyticsInstancesLifecycleStateCreating,
"DELETED": ListAnalyticsInstancesLifecycleStateDeleted,
"DELETING": ListAnalyticsInstancesLifecycleStateDeleting,
"FAILED": ListAnalyticsInstancesLifecycleStateFailed,
"INACTIVE": ListAnalyticsInstancesLifecycleStateInactive,
"UPDATING": ListAnalyticsInstancesLifecycleStateUpdating,
}
var mappingListAnalyticsInstancesLifecycleStateEnumLowerCase = map[string]ListAnalyticsInstancesLifecycleStateEnum{
"active": ListAnalyticsInstancesLifecycleStateActive,
"creating": ListAnalyticsInstancesLifecycleStateCreating,
"deleted": ListAnalyticsInstancesLifecycleStateDeleted,
"deleting": ListAnalyticsInstancesLifecycleStateDeleting,
"failed": ListAnalyticsInstancesLifecycleStateFailed,
"inactive": ListAnalyticsInstancesLifecycleStateInactive,
"updating": ListAnalyticsInstancesLifecycleStateUpdating,
}
// GetListAnalyticsInstancesLifecycleStateEnumValues Enumerates the set of values for ListAnalyticsInstancesLifecycleStateEnum
func GetListAnalyticsInstancesLifecycleStateEnumValues() []ListAnalyticsInstancesLifecycleStateEnum {
values := make([]ListAnalyticsInstancesLifecycleStateEnum, 0)
for _, v := range mappingListAnalyticsInstancesLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListAnalyticsInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesLifecycleStateEnum
func GetListAnalyticsInstancesLifecycleStateEnumStringValues() []string {
return []string{
"ACTIVE",
"CREATING",
"DELETED",
"DELETING",
"FAILED",
"INACTIVE",
"UPDATING",
}
}
// GetMappingListAnalyticsInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnalyticsInstancesLifecycleStateEnum(val string) (ListAnalyticsInstancesLifecycleStateEnum, bool) {
enum, ok := mappingListAnalyticsInstancesLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnalyticsInstancesSortByEnum Enum with underlying type: string
type ListAnalyticsInstancesSortByEnum string
// Set of constants representing the allowable values for ListAnalyticsInstancesSortByEnum
const (
ListAnalyticsInstancesSortByCapacitytype ListAnalyticsInstancesSortByEnum = "capacityType"
ListAnalyticsInstancesSortByCapacityvalue ListAnalyticsInstancesSortByEnum = "capacityValue"
ListAnalyticsInstancesSortByFeatureset ListAnalyticsInstancesSortByEnum = "featureSet"
ListAnalyticsInstancesSortByLifecyclestate ListAnalyticsInstancesSortByEnum = "lifecycleState"
ListAnalyticsInstancesSortByName ListAnalyticsInstancesSortByEnum = "name"
ListAnalyticsInstancesSortByTimecreated ListAnalyticsInstancesSortByEnum = "timeCreated"
)
var mappingListAnalyticsInstancesSortByEnum = map[string]ListAnalyticsInstancesSortByEnum{
"capacityType": ListAnalyticsInstancesSortByCapacitytype,
"capacityValue": ListAnalyticsInstancesSortByCapacityvalue,
"featureSet": ListAnalyticsInstancesSortByFeatureset,
"lifecycleState": ListAnalyticsInstancesSortByLifecyclestate,
"name": ListAnalyticsInstancesSortByName,
"timeCreated": ListAnalyticsInstancesSortByTimecreated,
}
var mappingListAnalyticsInstancesSortByEnumLowerCase = map[string]ListAnalyticsInstancesSortByEnum{
"capacitytype": ListAnalyticsInstancesSortByCapacitytype,
"capacityvalue": ListAnalyticsInstancesSortByCapacityvalue,
"featureset": ListAnalyticsInstancesSortByFeatureset,
"lifecyclestate": ListAnalyticsInstancesSortByLifecyclestate,
"name": ListAnalyticsInstancesSortByName,
"timecreated": ListAnalyticsInstancesSortByTimecreated,
}
// GetListAnalyticsInstancesSortByEnumValues Enumerates the set of values for ListAnalyticsInstancesSortByEnum
func GetListAnalyticsInstancesSortByEnumValues() []ListAnalyticsInstancesSortByEnum {
values := make([]ListAnalyticsInstancesSortByEnum, 0)
for _, v := range mappingListAnalyticsInstancesSortByEnum {
values = append(values, v)
}
return values
}
// GetListAnalyticsInstancesSortByEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortByEnum
func GetListAnalyticsInstancesSortByEnumStringValues() []string {
return []string{
"capacityType",
"capacityValue",
"featureSet",
"lifecycleState",
"name",
"timeCreated",
}
}
// GetMappingListAnalyticsInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnalyticsInstancesSortByEnum(val string) (ListAnalyticsInstancesSortByEnum, bool) {
enum, ok := mappingListAnalyticsInstancesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnalyticsInstancesSortOrderEnum Enum with underlying type: string
type ListAnalyticsInstancesSortOrderEnum string
// Set of constants representing the allowable values for ListAnalyticsInstancesSortOrderEnum
const (
ListAnalyticsInstancesSortOrderAsc ListAnalyticsInstancesSortOrderEnum = "ASC"
ListAnalyticsInstancesSortOrderDesc ListAnalyticsInstancesSortOrderEnum = "DESC"
)
var mappingListAnalyticsInstancesSortOrderEnum = map[string]ListAnalyticsInstancesSortOrderEnum{
"ASC": ListAnalyticsInstancesSortOrderAsc,
"DESC": ListAnalyticsInstancesSortOrderDesc,
}
var mappingListAnalyticsInstancesSortOrderEnumLowerCase = map[string]ListAnalyticsInstancesSortOrderEnum{
"asc": ListAnalyticsInstancesSortOrderAsc,
"desc": ListAnalyticsInstancesSortOrderDesc,
}
// GetListAnalyticsInstancesSortOrderEnumValues Enumerates the set of values for ListAnalyticsInstancesSortOrderEnum
func GetListAnalyticsInstancesSortOrderEnumValues() []ListAnalyticsInstancesSortOrderEnum {
values := make([]ListAnalyticsInstancesSortOrderEnum, 0)
for _, v := range mappingListAnalyticsInstancesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAnalyticsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortOrderEnum
func GetListAnalyticsInstancesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAnalyticsInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnalyticsInstancesSortOrderEnum(val string) (ListAnalyticsInstancesSortOrderEnum, bool) {
enum, ok := mappingListAnalyticsInstancesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}