-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_aggregated_physical_entities_request_response.go
337 lines (286 loc) · 17.2 KB
/
list_aggregated_physical_entities_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
// 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"
)
// ListAggregatedPhysicalEntitiesRequest wrapper for the ListAggregatedPhysicalEntities operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datacatalog/ListAggregatedPhysicalEntities.go.html to see an example of how to use ListAggregatedPhysicalEntitiesRequest.
type ListAggregatedPhysicalEntitiesRequest 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"`
// Specifies the fields to return in an entity response.
Fields []ListAggregatedPhysicalEntitiesFieldsEnum `contributesTo:"query" name:"fields" omitEmpty:"true" collectionFormat:"multi"`
// 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"`
// 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 ListAggregatedPhysicalEntitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAggregatedPhysicalEntitiesSortOrderEnum `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"`
// Indicates whether the properties map will be provided in the response.
IsIncludeProperties *bool `mandatory:"false" contributesTo:"query" name:"isIncludeProperties"`
// 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 ListAggregatedPhysicalEntitiesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAggregatedPhysicalEntitiesRequest) 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 ListAggregatedPhysicalEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAggregatedPhysicalEntitiesRequest) 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 ListAggregatedPhysicalEntitiesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
for _, val := range request.Fields {
if _, ok := GetMappingListAggregatedPhysicalEntitiesFieldsEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Fields: %s. Supported values are: %s.", val, strings.Join(GetListAggregatedPhysicalEntitiesFieldsEnumStringValues(), ",")))
}
}
if _, ok := GetMappingListAggregatedPhysicalEntitiesSortByEnum(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(GetListAggregatedPhysicalEntitiesSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAggregatedPhysicalEntitiesSortOrderEnum(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(GetListAggregatedPhysicalEntitiesSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAggregatedPhysicalEntitiesResponse wrapper for the ListAggregatedPhysicalEntities operation
type ListAggregatedPhysicalEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EntityCollection instances
EntityCollection `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"`
}
func (response ListAggregatedPhysicalEntitiesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAggregatedPhysicalEntitiesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAggregatedPhysicalEntitiesFieldsEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesFieldsEnum string
// Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesFieldsEnum
const (
ListAggregatedPhysicalEntitiesFieldsKey ListAggregatedPhysicalEntitiesFieldsEnum = "key"
ListAggregatedPhysicalEntitiesFieldsDisplayname ListAggregatedPhysicalEntitiesFieldsEnum = "displayName"
ListAggregatedPhysicalEntitiesFieldsDescription ListAggregatedPhysicalEntitiesFieldsEnum = "description"
ListAggregatedPhysicalEntitiesFieldsDataassetkey ListAggregatedPhysicalEntitiesFieldsEnum = "dataAssetKey"
ListAggregatedPhysicalEntitiesFieldsTimecreated ListAggregatedPhysicalEntitiesFieldsEnum = "timeCreated"
ListAggregatedPhysicalEntitiesFieldsTimeupdated ListAggregatedPhysicalEntitiesFieldsEnum = "timeUpdated"
ListAggregatedPhysicalEntitiesFieldsCreatedbyid ListAggregatedPhysicalEntitiesFieldsEnum = "createdById"
ListAggregatedPhysicalEntitiesFieldsUpdatedbyid ListAggregatedPhysicalEntitiesFieldsEnum = "updatedById"
ListAggregatedPhysicalEntitiesFieldsLifecyclestate ListAggregatedPhysicalEntitiesFieldsEnum = "lifecycleState"
ListAggregatedPhysicalEntitiesFieldsExternalkey ListAggregatedPhysicalEntitiesFieldsEnum = "externalKey"
ListAggregatedPhysicalEntitiesFieldsTimeexternal ListAggregatedPhysicalEntitiesFieldsEnum = "timeExternal"
ListAggregatedPhysicalEntitiesFieldsTimestatusupdated ListAggregatedPhysicalEntitiesFieldsEnum = "timeStatusUpdated"
ListAggregatedPhysicalEntitiesFieldsIslogical ListAggregatedPhysicalEntitiesFieldsEnum = "isLogical"
ListAggregatedPhysicalEntitiesFieldsIspartition ListAggregatedPhysicalEntitiesFieldsEnum = "isPartition"
ListAggregatedPhysicalEntitiesFieldsFolderkey ListAggregatedPhysicalEntitiesFieldsEnum = "folderKey"
ListAggregatedPhysicalEntitiesFieldsFoldername ListAggregatedPhysicalEntitiesFieldsEnum = "folderName"
ListAggregatedPhysicalEntitiesFieldsTypekey ListAggregatedPhysicalEntitiesFieldsEnum = "typeKey"
ListAggregatedPhysicalEntitiesFieldsPath ListAggregatedPhysicalEntitiesFieldsEnum = "path"
ListAggregatedPhysicalEntitiesFieldsHarveststatus ListAggregatedPhysicalEntitiesFieldsEnum = "harvestStatus"
ListAggregatedPhysicalEntitiesFieldsLastjobkey ListAggregatedPhysicalEntitiesFieldsEnum = "lastJobKey"
ListAggregatedPhysicalEntitiesFieldsUri ListAggregatedPhysicalEntitiesFieldsEnum = "uri"
ListAggregatedPhysicalEntitiesFieldsProperties ListAggregatedPhysicalEntitiesFieldsEnum = "properties"
)
var mappingListAggregatedPhysicalEntitiesFieldsEnum = map[string]ListAggregatedPhysicalEntitiesFieldsEnum{
"key": ListAggregatedPhysicalEntitiesFieldsKey,
"displayName": ListAggregatedPhysicalEntitiesFieldsDisplayname,
"description": ListAggregatedPhysicalEntitiesFieldsDescription,
"dataAssetKey": ListAggregatedPhysicalEntitiesFieldsDataassetkey,
"timeCreated": ListAggregatedPhysicalEntitiesFieldsTimecreated,
"timeUpdated": ListAggregatedPhysicalEntitiesFieldsTimeupdated,
"createdById": ListAggregatedPhysicalEntitiesFieldsCreatedbyid,
"updatedById": ListAggregatedPhysicalEntitiesFieldsUpdatedbyid,
"lifecycleState": ListAggregatedPhysicalEntitiesFieldsLifecyclestate,
"externalKey": ListAggregatedPhysicalEntitiesFieldsExternalkey,
"timeExternal": ListAggregatedPhysicalEntitiesFieldsTimeexternal,
"timeStatusUpdated": ListAggregatedPhysicalEntitiesFieldsTimestatusupdated,
"isLogical": ListAggregatedPhysicalEntitiesFieldsIslogical,
"isPartition": ListAggregatedPhysicalEntitiesFieldsIspartition,
"folderKey": ListAggregatedPhysicalEntitiesFieldsFolderkey,
"folderName": ListAggregatedPhysicalEntitiesFieldsFoldername,
"typeKey": ListAggregatedPhysicalEntitiesFieldsTypekey,
"path": ListAggregatedPhysicalEntitiesFieldsPath,
"harvestStatus": ListAggregatedPhysicalEntitiesFieldsHarveststatus,
"lastJobKey": ListAggregatedPhysicalEntitiesFieldsLastjobkey,
"uri": ListAggregatedPhysicalEntitiesFieldsUri,
"properties": ListAggregatedPhysicalEntitiesFieldsProperties,
}
var mappingListAggregatedPhysicalEntitiesFieldsEnumLowerCase = map[string]ListAggregatedPhysicalEntitiesFieldsEnum{
"key": ListAggregatedPhysicalEntitiesFieldsKey,
"displayname": ListAggregatedPhysicalEntitiesFieldsDisplayname,
"description": ListAggregatedPhysicalEntitiesFieldsDescription,
"dataassetkey": ListAggregatedPhysicalEntitiesFieldsDataassetkey,
"timecreated": ListAggregatedPhysicalEntitiesFieldsTimecreated,
"timeupdated": ListAggregatedPhysicalEntitiesFieldsTimeupdated,
"createdbyid": ListAggregatedPhysicalEntitiesFieldsCreatedbyid,
"updatedbyid": ListAggregatedPhysicalEntitiesFieldsUpdatedbyid,
"lifecyclestate": ListAggregatedPhysicalEntitiesFieldsLifecyclestate,
"externalkey": ListAggregatedPhysicalEntitiesFieldsExternalkey,
"timeexternal": ListAggregatedPhysicalEntitiesFieldsTimeexternal,
"timestatusupdated": ListAggregatedPhysicalEntitiesFieldsTimestatusupdated,
"islogical": ListAggregatedPhysicalEntitiesFieldsIslogical,
"ispartition": ListAggregatedPhysicalEntitiesFieldsIspartition,
"folderkey": ListAggregatedPhysicalEntitiesFieldsFolderkey,
"foldername": ListAggregatedPhysicalEntitiesFieldsFoldername,
"typekey": ListAggregatedPhysicalEntitiesFieldsTypekey,
"path": ListAggregatedPhysicalEntitiesFieldsPath,
"harveststatus": ListAggregatedPhysicalEntitiesFieldsHarveststatus,
"lastjobkey": ListAggregatedPhysicalEntitiesFieldsLastjobkey,
"uri": ListAggregatedPhysicalEntitiesFieldsUri,
"properties": ListAggregatedPhysicalEntitiesFieldsProperties,
}
// GetListAggregatedPhysicalEntitiesFieldsEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesFieldsEnum
func GetListAggregatedPhysicalEntitiesFieldsEnumValues() []ListAggregatedPhysicalEntitiesFieldsEnum {
values := make([]ListAggregatedPhysicalEntitiesFieldsEnum, 0)
for _, v := range mappingListAggregatedPhysicalEntitiesFieldsEnum {
values = append(values, v)
}
return values
}
// GetListAggregatedPhysicalEntitiesFieldsEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesFieldsEnum
func GetListAggregatedPhysicalEntitiesFieldsEnumStringValues() []string {
return []string{
"key",
"displayName",
"description",
"dataAssetKey",
"timeCreated",
"timeUpdated",
"createdById",
"updatedById",
"lifecycleState",
"externalKey",
"timeExternal",
"timeStatusUpdated",
"isLogical",
"isPartition",
"folderKey",
"folderName",
"typeKey",
"path",
"harvestStatus",
"lastJobKey",
"uri",
"properties",
}
}
// GetMappingListAggregatedPhysicalEntitiesFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAggregatedPhysicalEntitiesFieldsEnum(val string) (ListAggregatedPhysicalEntitiesFieldsEnum, bool) {
enum, ok := mappingListAggregatedPhysicalEntitiesFieldsEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAggregatedPhysicalEntitiesSortByEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesSortByEnum string
// Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesSortByEnum
const (
ListAggregatedPhysicalEntitiesSortByTimecreated ListAggregatedPhysicalEntitiesSortByEnum = "TIMECREATED"
ListAggregatedPhysicalEntitiesSortByDisplayname ListAggregatedPhysicalEntitiesSortByEnum = "DISPLAYNAME"
)
var mappingListAggregatedPhysicalEntitiesSortByEnum = map[string]ListAggregatedPhysicalEntitiesSortByEnum{
"TIMECREATED": ListAggregatedPhysicalEntitiesSortByTimecreated,
"DISPLAYNAME": ListAggregatedPhysicalEntitiesSortByDisplayname,
}
var mappingListAggregatedPhysicalEntitiesSortByEnumLowerCase = map[string]ListAggregatedPhysicalEntitiesSortByEnum{
"timecreated": ListAggregatedPhysicalEntitiesSortByTimecreated,
"displayname": ListAggregatedPhysicalEntitiesSortByDisplayname,
}
// GetListAggregatedPhysicalEntitiesSortByEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesSortByEnum
func GetListAggregatedPhysicalEntitiesSortByEnumValues() []ListAggregatedPhysicalEntitiesSortByEnum {
values := make([]ListAggregatedPhysicalEntitiesSortByEnum, 0)
for _, v := range mappingListAggregatedPhysicalEntitiesSortByEnum {
values = append(values, v)
}
return values
}
// GetListAggregatedPhysicalEntitiesSortByEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesSortByEnum
func GetListAggregatedPhysicalEntitiesSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
}
}
// GetMappingListAggregatedPhysicalEntitiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAggregatedPhysicalEntitiesSortByEnum(val string) (ListAggregatedPhysicalEntitiesSortByEnum, bool) {
enum, ok := mappingListAggregatedPhysicalEntitiesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAggregatedPhysicalEntitiesSortOrderEnum Enum with underlying type: string
type ListAggregatedPhysicalEntitiesSortOrderEnum string
// Set of constants representing the allowable values for ListAggregatedPhysicalEntitiesSortOrderEnum
const (
ListAggregatedPhysicalEntitiesSortOrderAsc ListAggregatedPhysicalEntitiesSortOrderEnum = "ASC"
ListAggregatedPhysicalEntitiesSortOrderDesc ListAggregatedPhysicalEntitiesSortOrderEnum = "DESC"
)
var mappingListAggregatedPhysicalEntitiesSortOrderEnum = map[string]ListAggregatedPhysicalEntitiesSortOrderEnum{
"ASC": ListAggregatedPhysicalEntitiesSortOrderAsc,
"DESC": ListAggregatedPhysicalEntitiesSortOrderDesc,
}
var mappingListAggregatedPhysicalEntitiesSortOrderEnumLowerCase = map[string]ListAggregatedPhysicalEntitiesSortOrderEnum{
"asc": ListAggregatedPhysicalEntitiesSortOrderAsc,
"desc": ListAggregatedPhysicalEntitiesSortOrderDesc,
}
// GetListAggregatedPhysicalEntitiesSortOrderEnumValues Enumerates the set of values for ListAggregatedPhysicalEntitiesSortOrderEnum
func GetListAggregatedPhysicalEntitiesSortOrderEnumValues() []ListAggregatedPhysicalEntitiesSortOrderEnum {
values := make([]ListAggregatedPhysicalEntitiesSortOrderEnum, 0)
for _, v := range mappingListAggregatedPhysicalEntitiesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAggregatedPhysicalEntitiesSortOrderEnumStringValues Enumerates the set of values in String for ListAggregatedPhysicalEntitiesSortOrderEnum
func GetListAggregatedPhysicalEntitiesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAggregatedPhysicalEntitiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAggregatedPhysicalEntitiesSortOrderEnum(val string) (ListAggregatedPhysicalEntitiesSortOrderEnum, bool) {
enum, ok := mappingListAggregatedPhysicalEntitiesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}