-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_attributes_request_response.go
463 lines (388 loc) · 21.5 KB
/
list_attributes_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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
// 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 datacatalog
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAttributesRequest wrapper for the ListAttributes operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAttributes.go.html to see an example of how to use ListAttributesRequest.
type ListAttributesRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique data asset key.
DataAssetKey *string `mandatory:"true" contributesTo:"path" name:"dataAssetKey"`
// Unique entity key.
EntityKey *string `mandatory:"true" contributesTo:"path" name:"entityKey"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire business name given. The match is not case sensitive.
BusinessName *string `mandatory:"false" contributesTo:"query" name:"businessName"`
// A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.
// For Example : /folders?displayOrBusinessNameContains=Cu.*
// The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayOrBusinessNameContains *string `mandatory:"false" contributesTo:"query" name:"displayOrBusinessNameContains"`
// A filter to return only resources that match display name pattern given. The match is not case sensitive.
// For Example : /folders?displayNameContains=Cu.*
// The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`
// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
LifecycleState ListAttributesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Time that the resource was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreated"`
// Time that the resource was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdated"`
// OCID of the user who created the resource.
CreatedById *string `mandatory:"false" contributesTo:"query" name:"createdById"`
// OCID of the user who updated the resource.
UpdatedById *string `mandatory:"false" contributesTo:"query" name:"updatedById"`
// Unique external identifier of this resource in the external source system.
ExternalKey *string `mandatory:"false" contributesTo:"query" name:"externalKey"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeExternal"`
// Data type as defined in an external system.
ExternalTypeName *string `mandatory:"false" contributesTo:"query" name:"externalTypeName"`
// Identifies whether this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" contributesTo:"query" name:"isIncrementalData"`
// Identifies whether this attribute can be assigned null value.
IsNullable *bool `mandatory:"false" contributesTo:"query" name:"isNullable"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" contributesTo:"query" name:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" contributesTo:"query" name:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" contributesTo:"query" name:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" contributesTo:"query" name:"scale"`
// Specifies the fields to return in an entity attribute summary response.
Fields []ListAttributesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for POSITION is ascending. If no value is specified POSITION is default.
SortBy ListAttributesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAttributesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 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 ListAttributesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAttributesRequest) 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 ListAttributesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAttributesRequest) 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 ListAttributesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAttributesLifecycleStateEnum(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(GetListAttributesLifecycleStateEnumStringValues(), ",")))
}
for _, val := range request.Fields {
if _, ok := GetMappingListAttributesFieldsEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Fields: %s. Supported values are: %s.", val, strings.Join(GetListAttributesFieldsEnumStringValues(), ",")))
}
}
if _, ok := GetMappingListAttributesSortByEnum(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(GetListAttributesSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAttributesSortOrderEnum(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(GetListAttributesSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAttributesResponse wrapper for the ListAttributes operation
type ListAttributesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AttributeCollection instances
AttributeCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAttributesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAttributesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAttributesLifecycleStateEnum Enum with underlying type: string
type ListAttributesLifecycleStateEnum string
// Set of constants representing the allowable values for ListAttributesLifecycleStateEnum
const (
ListAttributesLifecycleStateCreating ListAttributesLifecycleStateEnum = "CREATING"
ListAttributesLifecycleStateActive ListAttributesLifecycleStateEnum = "ACTIVE"
ListAttributesLifecycleStateInactive ListAttributesLifecycleStateEnum = "INACTIVE"
ListAttributesLifecycleStateUpdating ListAttributesLifecycleStateEnum = "UPDATING"
ListAttributesLifecycleStateDeleting ListAttributesLifecycleStateEnum = "DELETING"
ListAttributesLifecycleStateDeleted ListAttributesLifecycleStateEnum = "DELETED"
ListAttributesLifecycleStateFailed ListAttributesLifecycleStateEnum = "FAILED"
ListAttributesLifecycleStateMoving ListAttributesLifecycleStateEnum = "MOVING"
)
var mappingListAttributesLifecycleStateEnum = map[string]ListAttributesLifecycleStateEnum{
"CREATING": ListAttributesLifecycleStateCreating,
"ACTIVE": ListAttributesLifecycleStateActive,
"INACTIVE": ListAttributesLifecycleStateInactive,
"UPDATING": ListAttributesLifecycleStateUpdating,
"DELETING": ListAttributesLifecycleStateDeleting,
"DELETED": ListAttributesLifecycleStateDeleted,
"FAILED": ListAttributesLifecycleStateFailed,
"MOVING": ListAttributesLifecycleStateMoving,
}
var mappingListAttributesLifecycleStateEnumLowerCase = map[string]ListAttributesLifecycleStateEnum{
"creating": ListAttributesLifecycleStateCreating,
"active": ListAttributesLifecycleStateActive,
"inactive": ListAttributesLifecycleStateInactive,
"updating": ListAttributesLifecycleStateUpdating,
"deleting": ListAttributesLifecycleStateDeleting,
"deleted": ListAttributesLifecycleStateDeleted,
"failed": ListAttributesLifecycleStateFailed,
"moving": ListAttributesLifecycleStateMoving,
}
// GetListAttributesLifecycleStateEnumValues Enumerates the set of values for ListAttributesLifecycleStateEnum
func GetListAttributesLifecycleStateEnumValues() []ListAttributesLifecycleStateEnum {
values := make([]ListAttributesLifecycleStateEnum, 0)
for _, v := range mappingListAttributesLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListAttributesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAttributesLifecycleStateEnum
func GetListAttributesLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"ACTIVE",
"INACTIVE",
"UPDATING",
"DELETING",
"DELETED",
"FAILED",
"MOVING",
}
}
// GetMappingListAttributesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAttributesLifecycleStateEnum(val string) (ListAttributesLifecycleStateEnum, bool) {
enum, ok := mappingListAttributesLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAttributesFieldsEnum Enum with underlying type: string
type ListAttributesFieldsEnum string
// Set of constants representing the allowable values for ListAttributesFieldsEnum
const (
ListAttributesFieldsKey ListAttributesFieldsEnum = "key"
ListAttributesFieldsDisplayname ListAttributesFieldsEnum = "displayName"
ListAttributesFieldsDescription ListAttributesFieldsEnum = "description"
ListAttributesFieldsEntitykey ListAttributesFieldsEnum = "entityKey"
ListAttributesFieldsLifecyclestate ListAttributesFieldsEnum = "lifecycleState"
ListAttributesFieldsTimecreated ListAttributesFieldsEnum = "timeCreated"
ListAttributesFieldsExternaldatatype ListAttributesFieldsEnum = "externalDataType"
ListAttributesFieldsExternalkey ListAttributesFieldsEnum = "externalKey"
ListAttributesFieldsLength ListAttributesFieldsEnum = "length"
ListAttributesFieldsPrecision ListAttributesFieldsEnum = "precision"
ListAttributesFieldsScale ListAttributesFieldsEnum = "scale"
ListAttributesFieldsIsnullable ListAttributesFieldsEnum = "isNullable"
ListAttributesFieldsUri ListAttributesFieldsEnum = "uri"
ListAttributesFieldsPath ListAttributesFieldsEnum = "path"
ListAttributesFieldsMincollectioncount ListAttributesFieldsEnum = "minCollectionCount"
ListAttributesFieldsMaxcollectioncount ListAttributesFieldsEnum = "maxCollectionCount"
ListAttributesFieldsDatatypeentitykey ListAttributesFieldsEnum = "datatypeEntityKey"
ListAttributesFieldsExternaldatatypeentitykey ListAttributesFieldsEnum = "externalDatatypeEntityKey"
ListAttributesFieldsParentattributekey ListAttributesFieldsEnum = "parentAttributeKey"
ListAttributesFieldsExternalparentattributekey ListAttributesFieldsEnum = "externalParentAttributeKey"
ListAttributesFieldsPosition ListAttributesFieldsEnum = "position"
ListAttributesFieldsTypekey ListAttributesFieldsEnum = "typeKey"
)
var mappingListAttributesFieldsEnum = map[string]ListAttributesFieldsEnum{
"key": ListAttributesFieldsKey,
"displayName": ListAttributesFieldsDisplayname,
"description": ListAttributesFieldsDescription,
"entityKey": ListAttributesFieldsEntitykey,
"lifecycleState": ListAttributesFieldsLifecyclestate,
"timeCreated": ListAttributesFieldsTimecreated,
"externalDataType": ListAttributesFieldsExternaldatatype,
"externalKey": ListAttributesFieldsExternalkey,
"length": ListAttributesFieldsLength,
"precision": ListAttributesFieldsPrecision,
"scale": ListAttributesFieldsScale,
"isNullable": ListAttributesFieldsIsnullable,
"uri": ListAttributesFieldsUri,
"path": ListAttributesFieldsPath,
"minCollectionCount": ListAttributesFieldsMincollectioncount,
"maxCollectionCount": ListAttributesFieldsMaxcollectioncount,
"datatypeEntityKey": ListAttributesFieldsDatatypeentitykey,
"externalDatatypeEntityKey": ListAttributesFieldsExternaldatatypeentitykey,
"parentAttributeKey": ListAttributesFieldsParentattributekey,
"externalParentAttributeKey": ListAttributesFieldsExternalparentattributekey,
"position": ListAttributesFieldsPosition,
"typeKey": ListAttributesFieldsTypekey,
}
var mappingListAttributesFieldsEnumLowerCase = map[string]ListAttributesFieldsEnum{
"key": ListAttributesFieldsKey,
"displayname": ListAttributesFieldsDisplayname,
"description": ListAttributesFieldsDescription,
"entitykey": ListAttributesFieldsEntitykey,
"lifecyclestate": ListAttributesFieldsLifecyclestate,
"timecreated": ListAttributesFieldsTimecreated,
"externaldatatype": ListAttributesFieldsExternaldatatype,
"externalkey": ListAttributesFieldsExternalkey,
"length": ListAttributesFieldsLength,
"precision": ListAttributesFieldsPrecision,
"scale": ListAttributesFieldsScale,
"isnullable": ListAttributesFieldsIsnullable,
"uri": ListAttributesFieldsUri,
"path": ListAttributesFieldsPath,
"mincollectioncount": ListAttributesFieldsMincollectioncount,
"maxcollectioncount": ListAttributesFieldsMaxcollectioncount,
"datatypeentitykey": ListAttributesFieldsDatatypeentitykey,
"externaldatatypeentitykey": ListAttributesFieldsExternaldatatypeentitykey,
"parentattributekey": ListAttributesFieldsParentattributekey,
"externalparentattributekey": ListAttributesFieldsExternalparentattributekey,
"position": ListAttributesFieldsPosition,
"typekey": ListAttributesFieldsTypekey,
}
// GetListAttributesFieldsEnumValues Enumerates the set of values for ListAttributesFieldsEnum
func GetListAttributesFieldsEnumValues() []ListAttributesFieldsEnum {
values := make([]ListAttributesFieldsEnum, 0)
for _, v := range mappingListAttributesFieldsEnum {
values = append(values, v)
}
return values
}
// GetListAttributesFieldsEnumStringValues Enumerates the set of values in String for ListAttributesFieldsEnum
func GetListAttributesFieldsEnumStringValues() []string {
return []string{
"key",
"displayName",
"description",
"entityKey",
"lifecycleState",
"timeCreated",
"externalDataType",
"externalKey",
"length",
"precision",
"scale",
"isNullable",
"uri",
"path",
"minCollectionCount",
"maxCollectionCount",
"datatypeEntityKey",
"externalDatatypeEntityKey",
"parentAttributeKey",
"externalParentAttributeKey",
"position",
"typeKey",
}
}
// GetMappingListAttributesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAttributesFieldsEnum(val string) (ListAttributesFieldsEnum, bool) {
enum, ok := mappingListAttributesFieldsEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAttributesSortByEnum Enum with underlying type: string
type ListAttributesSortByEnum string
// Set of constants representing the allowable values for ListAttributesSortByEnum
const (
ListAttributesSortByTimecreated ListAttributesSortByEnum = "TIMECREATED"
ListAttributesSortByDisplayname ListAttributesSortByEnum = "DISPLAYNAME"
ListAttributesSortByPosition ListAttributesSortByEnum = "POSITION"
)
var mappingListAttributesSortByEnum = map[string]ListAttributesSortByEnum{
"TIMECREATED": ListAttributesSortByTimecreated,
"DISPLAYNAME": ListAttributesSortByDisplayname,
"POSITION": ListAttributesSortByPosition,
}
var mappingListAttributesSortByEnumLowerCase = map[string]ListAttributesSortByEnum{
"timecreated": ListAttributesSortByTimecreated,
"displayname": ListAttributesSortByDisplayname,
"position": ListAttributesSortByPosition,
}
// GetListAttributesSortByEnumValues Enumerates the set of values for ListAttributesSortByEnum
func GetListAttributesSortByEnumValues() []ListAttributesSortByEnum {
values := make([]ListAttributesSortByEnum, 0)
for _, v := range mappingListAttributesSortByEnum {
values = append(values, v)
}
return values
}
// GetListAttributesSortByEnumStringValues Enumerates the set of values in String for ListAttributesSortByEnum
func GetListAttributesSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
"POSITION",
}
}
// GetMappingListAttributesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAttributesSortByEnum(val string) (ListAttributesSortByEnum, bool) {
enum, ok := mappingListAttributesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAttributesSortOrderEnum Enum with underlying type: string
type ListAttributesSortOrderEnum string
// Set of constants representing the allowable values for ListAttributesSortOrderEnum
const (
ListAttributesSortOrderAsc ListAttributesSortOrderEnum = "ASC"
ListAttributesSortOrderDesc ListAttributesSortOrderEnum = "DESC"
)
var mappingListAttributesSortOrderEnum = map[string]ListAttributesSortOrderEnum{
"ASC": ListAttributesSortOrderAsc,
"DESC": ListAttributesSortOrderDesc,
}
var mappingListAttributesSortOrderEnumLowerCase = map[string]ListAttributesSortOrderEnum{
"asc": ListAttributesSortOrderAsc,
"desc": ListAttributesSortOrderDesc,
}
// GetListAttributesSortOrderEnumValues Enumerates the set of values for ListAttributesSortOrderEnum
func GetListAttributesSortOrderEnumValues() []ListAttributesSortOrderEnum {
values := make([]ListAttributesSortOrderEnum, 0)
for _, v := range mappingListAttributesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAttributesSortOrderEnumStringValues Enumerates the set of values in String for ListAttributesSortOrderEnum
func GetListAttributesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAttributesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAttributesSortOrderEnum(val string) (ListAttributesSortOrderEnum, bool) {
enum, ok := mappingListAttributesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}