-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_terms_request_response.go
434 lines (364 loc) · 18.1 KB
/
list_terms_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
// Copyright (c) 2016, 2018, 2022, 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"
)
// ListTermsRequest wrapper for the ListTerms operation
//
// See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListTerms.go.html to see an example of how to use ListTermsRequest.
type ListTermsRequest struct {
// Unique catalog identifier.
CatalogId *string `mandatory:"true" contributesTo:"path" name:"catalogId"`
// Unique glossary key.
GlossaryKey *string `mandatory:"true" contributesTo:"path" name:"glossaryKey"`
// 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 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 ListTermsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique key of the parent term.
ParentTermKey *string `mandatory:"false" contributesTo:"query" name:"parentTermKey"`
// Indicates whether a term may contain child terms.
IsAllowedToHaveChildTerms *bool `mandatory:"false" contributesTo:"query" name:"isAllowedToHaveChildTerms"`
// Status of the approval workflow for this business term in the glossary.
WorkflowStatus ListTermsWorkflowStatusEnum `mandatory:"false" contributesTo:"query" name:"workflowStatus" omitEmpty:"true"`
// Full path of the resource for resources that support paths.
Path *string `mandatory:"false" contributesTo:"query" name:"path"`
// Specifies the fields to return in a term summary response.
Fields []ListTermsFieldsEnum `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. If no value is specified TIMECREATED is default.
SortBy ListTermsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListTermsSortOrderEnum `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 ListTermsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListTermsRequest) 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 ListTermsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTermsRequest) 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 ListTermsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListTermsLifecycleStateEnum(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(GetListTermsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListTermsWorkflowStatusEnum(string(request.WorkflowStatus)); !ok && request.WorkflowStatus != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for WorkflowStatus: %s. Supported values are: %s.", request.WorkflowStatus, strings.Join(GetListTermsWorkflowStatusEnumStringValues(), ",")))
}
for _, val := range request.Fields {
if _, ok := GetMappingListTermsFieldsEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Fields: %s. Supported values are: %s.", val, strings.Join(GetListTermsFieldsEnumStringValues(), ",")))
}
}
if _, ok := GetMappingListTermsSortByEnum(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(GetListTermsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListTermsSortOrderEnum(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(GetListTermsSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListTermsResponse wrapper for the ListTerms operation
type ListTermsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TermCollection instances
TermCollection `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 ListTermsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListTermsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListTermsLifecycleStateEnum Enum with underlying type: string
type ListTermsLifecycleStateEnum string
// Set of constants representing the allowable values for ListTermsLifecycleStateEnum
const (
ListTermsLifecycleStateCreating ListTermsLifecycleStateEnum = "CREATING"
ListTermsLifecycleStateActive ListTermsLifecycleStateEnum = "ACTIVE"
ListTermsLifecycleStateInactive ListTermsLifecycleStateEnum = "INACTIVE"
ListTermsLifecycleStateUpdating ListTermsLifecycleStateEnum = "UPDATING"
ListTermsLifecycleStateDeleting ListTermsLifecycleStateEnum = "DELETING"
ListTermsLifecycleStateDeleted ListTermsLifecycleStateEnum = "DELETED"
ListTermsLifecycleStateFailed ListTermsLifecycleStateEnum = "FAILED"
ListTermsLifecycleStateMoving ListTermsLifecycleStateEnum = "MOVING"
)
var mappingListTermsLifecycleStateEnum = map[string]ListTermsLifecycleStateEnum{
"CREATING": ListTermsLifecycleStateCreating,
"ACTIVE": ListTermsLifecycleStateActive,
"INACTIVE": ListTermsLifecycleStateInactive,
"UPDATING": ListTermsLifecycleStateUpdating,
"DELETING": ListTermsLifecycleStateDeleting,
"DELETED": ListTermsLifecycleStateDeleted,
"FAILED": ListTermsLifecycleStateFailed,
"MOVING": ListTermsLifecycleStateMoving,
}
var mappingListTermsLifecycleStateEnumLowerCase = map[string]ListTermsLifecycleStateEnum{
"creating": ListTermsLifecycleStateCreating,
"active": ListTermsLifecycleStateActive,
"inactive": ListTermsLifecycleStateInactive,
"updating": ListTermsLifecycleStateUpdating,
"deleting": ListTermsLifecycleStateDeleting,
"deleted": ListTermsLifecycleStateDeleted,
"failed": ListTermsLifecycleStateFailed,
"moving": ListTermsLifecycleStateMoving,
}
// GetListTermsLifecycleStateEnumValues Enumerates the set of values for ListTermsLifecycleStateEnum
func GetListTermsLifecycleStateEnumValues() []ListTermsLifecycleStateEnum {
values := make([]ListTermsLifecycleStateEnum, 0)
for _, v := range mappingListTermsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListTermsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTermsLifecycleStateEnum
func GetListTermsLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"ACTIVE",
"INACTIVE",
"UPDATING",
"DELETING",
"DELETED",
"FAILED",
"MOVING",
}
}
// GetMappingListTermsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTermsLifecycleStateEnum(val string) (ListTermsLifecycleStateEnum, bool) {
enum, ok := mappingListTermsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListTermsWorkflowStatusEnum Enum with underlying type: string
type ListTermsWorkflowStatusEnum string
// Set of constants representing the allowable values for ListTermsWorkflowStatusEnum
const (
ListTermsWorkflowStatusNew ListTermsWorkflowStatusEnum = "NEW"
ListTermsWorkflowStatusApproved ListTermsWorkflowStatusEnum = "APPROVED"
ListTermsWorkflowStatusUnderReview ListTermsWorkflowStatusEnum = "UNDER_REVIEW"
ListTermsWorkflowStatusEscalated ListTermsWorkflowStatusEnum = "ESCALATED"
)
var mappingListTermsWorkflowStatusEnum = map[string]ListTermsWorkflowStatusEnum{
"NEW": ListTermsWorkflowStatusNew,
"APPROVED": ListTermsWorkflowStatusApproved,
"UNDER_REVIEW": ListTermsWorkflowStatusUnderReview,
"ESCALATED": ListTermsWorkflowStatusEscalated,
}
var mappingListTermsWorkflowStatusEnumLowerCase = map[string]ListTermsWorkflowStatusEnum{
"new": ListTermsWorkflowStatusNew,
"approved": ListTermsWorkflowStatusApproved,
"under_review": ListTermsWorkflowStatusUnderReview,
"escalated": ListTermsWorkflowStatusEscalated,
}
// GetListTermsWorkflowStatusEnumValues Enumerates the set of values for ListTermsWorkflowStatusEnum
func GetListTermsWorkflowStatusEnumValues() []ListTermsWorkflowStatusEnum {
values := make([]ListTermsWorkflowStatusEnum, 0)
for _, v := range mappingListTermsWorkflowStatusEnum {
values = append(values, v)
}
return values
}
// GetListTermsWorkflowStatusEnumStringValues Enumerates the set of values in String for ListTermsWorkflowStatusEnum
func GetListTermsWorkflowStatusEnumStringValues() []string {
return []string{
"NEW",
"APPROVED",
"UNDER_REVIEW",
"ESCALATED",
}
}
// GetMappingListTermsWorkflowStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTermsWorkflowStatusEnum(val string) (ListTermsWorkflowStatusEnum, bool) {
enum, ok := mappingListTermsWorkflowStatusEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListTermsFieldsEnum Enum with underlying type: string
type ListTermsFieldsEnum string
// Set of constants representing the allowable values for ListTermsFieldsEnum
const (
ListTermsFieldsKey ListTermsFieldsEnum = "key"
ListTermsFieldsDisplayname ListTermsFieldsEnum = "displayName"
ListTermsFieldsDescription ListTermsFieldsEnum = "description"
ListTermsFieldsGlossarykey ListTermsFieldsEnum = "glossaryKey"
ListTermsFieldsParenttermkey ListTermsFieldsEnum = "parentTermKey"
ListTermsFieldsIsallowedtohavechildterms ListTermsFieldsEnum = "isAllowedToHaveChildTerms"
ListTermsFieldsPath ListTermsFieldsEnum = "path"
ListTermsFieldsLifecyclestate ListTermsFieldsEnum = "lifecycleState"
ListTermsFieldsTimecreated ListTermsFieldsEnum = "timeCreated"
ListTermsFieldsWorkflowstatus ListTermsFieldsEnum = "workflowStatus"
ListTermsFieldsAssociatedobjectcount ListTermsFieldsEnum = "associatedObjectCount"
ListTermsFieldsUri ListTermsFieldsEnum = "uri"
)
var mappingListTermsFieldsEnum = map[string]ListTermsFieldsEnum{
"key": ListTermsFieldsKey,
"displayName": ListTermsFieldsDisplayname,
"description": ListTermsFieldsDescription,
"glossaryKey": ListTermsFieldsGlossarykey,
"parentTermKey": ListTermsFieldsParenttermkey,
"isAllowedToHaveChildTerms": ListTermsFieldsIsallowedtohavechildterms,
"path": ListTermsFieldsPath,
"lifecycleState": ListTermsFieldsLifecyclestate,
"timeCreated": ListTermsFieldsTimecreated,
"workflowStatus": ListTermsFieldsWorkflowstatus,
"associatedObjectCount": ListTermsFieldsAssociatedobjectcount,
"uri": ListTermsFieldsUri,
}
var mappingListTermsFieldsEnumLowerCase = map[string]ListTermsFieldsEnum{
"key": ListTermsFieldsKey,
"displayname": ListTermsFieldsDisplayname,
"description": ListTermsFieldsDescription,
"glossarykey": ListTermsFieldsGlossarykey,
"parenttermkey": ListTermsFieldsParenttermkey,
"isallowedtohavechildterms": ListTermsFieldsIsallowedtohavechildterms,
"path": ListTermsFieldsPath,
"lifecyclestate": ListTermsFieldsLifecyclestate,
"timecreated": ListTermsFieldsTimecreated,
"workflowstatus": ListTermsFieldsWorkflowstatus,
"associatedobjectcount": ListTermsFieldsAssociatedobjectcount,
"uri": ListTermsFieldsUri,
}
// GetListTermsFieldsEnumValues Enumerates the set of values for ListTermsFieldsEnum
func GetListTermsFieldsEnumValues() []ListTermsFieldsEnum {
values := make([]ListTermsFieldsEnum, 0)
for _, v := range mappingListTermsFieldsEnum {
values = append(values, v)
}
return values
}
// GetListTermsFieldsEnumStringValues Enumerates the set of values in String for ListTermsFieldsEnum
func GetListTermsFieldsEnumStringValues() []string {
return []string{
"key",
"displayName",
"description",
"glossaryKey",
"parentTermKey",
"isAllowedToHaveChildTerms",
"path",
"lifecycleState",
"timeCreated",
"workflowStatus",
"associatedObjectCount",
"uri",
}
}
// GetMappingListTermsFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTermsFieldsEnum(val string) (ListTermsFieldsEnum, bool) {
enum, ok := mappingListTermsFieldsEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListTermsSortByEnum Enum with underlying type: string
type ListTermsSortByEnum string
// Set of constants representing the allowable values for ListTermsSortByEnum
const (
ListTermsSortByTimecreated ListTermsSortByEnum = "TIMECREATED"
ListTermsSortByDisplayname ListTermsSortByEnum = "DISPLAYNAME"
)
var mappingListTermsSortByEnum = map[string]ListTermsSortByEnum{
"TIMECREATED": ListTermsSortByTimecreated,
"DISPLAYNAME": ListTermsSortByDisplayname,
}
var mappingListTermsSortByEnumLowerCase = map[string]ListTermsSortByEnum{
"timecreated": ListTermsSortByTimecreated,
"displayname": ListTermsSortByDisplayname,
}
// GetListTermsSortByEnumValues Enumerates the set of values for ListTermsSortByEnum
func GetListTermsSortByEnumValues() []ListTermsSortByEnum {
values := make([]ListTermsSortByEnum, 0)
for _, v := range mappingListTermsSortByEnum {
values = append(values, v)
}
return values
}
// GetListTermsSortByEnumStringValues Enumerates the set of values in String for ListTermsSortByEnum
func GetListTermsSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
}
}
// GetMappingListTermsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTermsSortByEnum(val string) (ListTermsSortByEnum, bool) {
enum, ok := mappingListTermsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListTermsSortOrderEnum Enum with underlying type: string
type ListTermsSortOrderEnum string
// Set of constants representing the allowable values for ListTermsSortOrderEnum
const (
ListTermsSortOrderAsc ListTermsSortOrderEnum = "ASC"
ListTermsSortOrderDesc ListTermsSortOrderEnum = "DESC"
)
var mappingListTermsSortOrderEnum = map[string]ListTermsSortOrderEnum{
"ASC": ListTermsSortOrderAsc,
"DESC": ListTermsSortOrderDesc,
}
var mappingListTermsSortOrderEnumLowerCase = map[string]ListTermsSortOrderEnum{
"asc": ListTermsSortOrderAsc,
"desc": ListTermsSortOrderDesc,
}
// GetListTermsSortOrderEnumValues Enumerates the set of values for ListTermsSortOrderEnum
func GetListTermsSortOrderEnumValues() []ListTermsSortOrderEnum {
values := make([]ListTermsSortOrderEnum, 0)
for _, v := range mappingListTermsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListTermsSortOrderEnumStringValues Enumerates the set of values in String for ListTermsSortOrderEnum
func GetListTermsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListTermsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTermsSortOrderEnum(val string) (ListTermsSortOrderEnum, bool) {
enum, ok := mappingListTermsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}