/
list_channels_request_response.go
447 lines (381 loc) · 17.9 KB
/
list_channels_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
// Copyright (c) 2016, 2018, 2024, 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 oda
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListChannelsRequest wrapper for the ListChannels operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListChannels.go.html to see an example of how to use ListChannelsRequest.
type ListChannelsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only the information for Channels with this name. Channels names are unique and may not change.
// Example: `MyChannel`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only Channels with this category.
Category ListChannelsCategoryEnum `mandatory:"false" contributesTo:"query" name:"category" omitEmpty:"true"`
// List only Channels of this type.
Type ListChannelsTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`
// List only the resources that are in this lifecycle state.
LifecycleState ListChannelsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListChannelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending, and the default sort order for `name` is ascending.
SortBy ListChannelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
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 ListChannelsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListChannelsRequest) 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 ListChannelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListChannelsRequest) 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 ListChannelsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListChannelsCategoryEnum(string(request.Category)); !ok && request.Category != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Category: %s. Supported values are: %s.", request.Category, strings.Join(GetListChannelsCategoryEnumStringValues(), ",")))
}
if _, ok := GetMappingListChannelsTypeEnum(string(request.Type)); !ok && request.Type != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Type: %s. Supported values are: %s.", request.Type, strings.Join(GetListChannelsTypeEnumStringValues(), ",")))
}
if _, ok := GetMappingListChannelsLifecycleStateEnum(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(GetListChannelsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListChannelsSortOrderEnum(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(GetListChannelsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListChannelsSortByEnum(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(GetListChannelsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListChannelsResponse wrapper for the ListChannels operation
type ListChannelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ChannelCollection instances
ChannelCollection `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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListChannelsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListChannelsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListChannelsCategoryEnum Enum with underlying type: string
type ListChannelsCategoryEnum string
// Set of constants representing the allowable values for ListChannelsCategoryEnum
const (
ListChannelsCategoryAgent ListChannelsCategoryEnum = "AGENT"
ListChannelsCategoryApplication ListChannelsCategoryEnum = "APPLICATION"
ListChannelsCategoryBot ListChannelsCategoryEnum = "BOT"
ListChannelsCategoryBotAsAgent ListChannelsCategoryEnum = "BOT_AS_AGENT"
ListChannelsCategorySystem ListChannelsCategoryEnum = "SYSTEM"
ListChannelsCategoryEvent ListChannelsCategoryEnum = "EVENT"
)
var mappingListChannelsCategoryEnum = map[string]ListChannelsCategoryEnum{
"AGENT": ListChannelsCategoryAgent,
"APPLICATION": ListChannelsCategoryApplication,
"BOT": ListChannelsCategoryBot,
"BOT_AS_AGENT": ListChannelsCategoryBotAsAgent,
"SYSTEM": ListChannelsCategorySystem,
"EVENT": ListChannelsCategoryEvent,
}
var mappingListChannelsCategoryEnumLowerCase = map[string]ListChannelsCategoryEnum{
"agent": ListChannelsCategoryAgent,
"application": ListChannelsCategoryApplication,
"bot": ListChannelsCategoryBot,
"bot_as_agent": ListChannelsCategoryBotAsAgent,
"system": ListChannelsCategorySystem,
"event": ListChannelsCategoryEvent,
}
// GetListChannelsCategoryEnumValues Enumerates the set of values for ListChannelsCategoryEnum
func GetListChannelsCategoryEnumValues() []ListChannelsCategoryEnum {
values := make([]ListChannelsCategoryEnum, 0)
for _, v := range mappingListChannelsCategoryEnum {
values = append(values, v)
}
return values
}
// GetListChannelsCategoryEnumStringValues Enumerates the set of values in String for ListChannelsCategoryEnum
func GetListChannelsCategoryEnumStringValues() []string {
return []string{
"AGENT",
"APPLICATION",
"BOT",
"BOT_AS_AGENT",
"SYSTEM",
"EVENT",
}
}
// GetMappingListChannelsCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListChannelsCategoryEnum(val string) (ListChannelsCategoryEnum, bool) {
enum, ok := mappingListChannelsCategoryEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListChannelsTypeEnum Enum with underlying type: string
type ListChannelsTypeEnum string
// Set of constants representing the allowable values for ListChannelsTypeEnum
const (
ListChannelsTypeAndroid ListChannelsTypeEnum = "ANDROID"
ListChannelsTypeAppevent ListChannelsTypeEnum = "APPEVENT"
ListChannelsTypeApplication ListChannelsTypeEnum = "APPLICATION"
ListChannelsTypeCortana ListChannelsTypeEnum = "CORTANA"
ListChannelsTypeFacebook ListChannelsTypeEnum = "FACEBOOK"
ListChannelsTypeIos ListChannelsTypeEnum = "IOS"
ListChannelsTypeMsteams ListChannelsTypeEnum = "MSTEAMS"
ListChannelsTypeOss ListChannelsTypeEnum = "OSS"
ListChannelsTypeOsvc ListChannelsTypeEnum = "OSVC"
ListChannelsTypeServicecloud ListChannelsTypeEnum = "SERVICECLOUD"
ListChannelsTypeSlack ListChannelsTypeEnum = "SLACK"
ListChannelsTypeTest ListChannelsTypeEnum = "TEST"
ListChannelsTypeTwilio ListChannelsTypeEnum = "TWILIO"
ListChannelsTypeWeb ListChannelsTypeEnum = "WEB"
ListChannelsTypeWebhook ListChannelsTypeEnum = "WEBHOOK"
)
var mappingListChannelsTypeEnum = map[string]ListChannelsTypeEnum{
"ANDROID": ListChannelsTypeAndroid,
"APPEVENT": ListChannelsTypeAppevent,
"APPLICATION": ListChannelsTypeApplication,
"CORTANA": ListChannelsTypeCortana,
"FACEBOOK": ListChannelsTypeFacebook,
"IOS": ListChannelsTypeIos,
"MSTEAMS": ListChannelsTypeMsteams,
"OSS": ListChannelsTypeOss,
"OSVC": ListChannelsTypeOsvc,
"SERVICECLOUD": ListChannelsTypeServicecloud,
"SLACK": ListChannelsTypeSlack,
"TEST": ListChannelsTypeTest,
"TWILIO": ListChannelsTypeTwilio,
"WEB": ListChannelsTypeWeb,
"WEBHOOK": ListChannelsTypeWebhook,
}
var mappingListChannelsTypeEnumLowerCase = map[string]ListChannelsTypeEnum{
"android": ListChannelsTypeAndroid,
"appevent": ListChannelsTypeAppevent,
"application": ListChannelsTypeApplication,
"cortana": ListChannelsTypeCortana,
"facebook": ListChannelsTypeFacebook,
"ios": ListChannelsTypeIos,
"msteams": ListChannelsTypeMsteams,
"oss": ListChannelsTypeOss,
"osvc": ListChannelsTypeOsvc,
"servicecloud": ListChannelsTypeServicecloud,
"slack": ListChannelsTypeSlack,
"test": ListChannelsTypeTest,
"twilio": ListChannelsTypeTwilio,
"web": ListChannelsTypeWeb,
"webhook": ListChannelsTypeWebhook,
}
// GetListChannelsTypeEnumValues Enumerates the set of values for ListChannelsTypeEnum
func GetListChannelsTypeEnumValues() []ListChannelsTypeEnum {
values := make([]ListChannelsTypeEnum, 0)
for _, v := range mappingListChannelsTypeEnum {
values = append(values, v)
}
return values
}
// GetListChannelsTypeEnumStringValues Enumerates the set of values in String for ListChannelsTypeEnum
func GetListChannelsTypeEnumStringValues() []string {
return []string{
"ANDROID",
"APPEVENT",
"APPLICATION",
"CORTANA",
"FACEBOOK",
"IOS",
"MSTEAMS",
"OSS",
"OSVC",
"SERVICECLOUD",
"SLACK",
"TEST",
"TWILIO",
"WEB",
"WEBHOOK",
}
}
// GetMappingListChannelsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListChannelsTypeEnum(val string) (ListChannelsTypeEnum, bool) {
enum, ok := mappingListChannelsTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListChannelsLifecycleStateEnum Enum with underlying type: string
type ListChannelsLifecycleStateEnum string
// Set of constants representing the allowable values for ListChannelsLifecycleStateEnum
const (
ListChannelsLifecycleStateCreating ListChannelsLifecycleStateEnum = "CREATING"
ListChannelsLifecycleStateUpdating ListChannelsLifecycleStateEnum = "UPDATING"
ListChannelsLifecycleStateActive ListChannelsLifecycleStateEnum = "ACTIVE"
ListChannelsLifecycleStateInactive ListChannelsLifecycleStateEnum = "INACTIVE"
ListChannelsLifecycleStateDeleting ListChannelsLifecycleStateEnum = "DELETING"
ListChannelsLifecycleStateDeleted ListChannelsLifecycleStateEnum = "DELETED"
ListChannelsLifecycleStateFailed ListChannelsLifecycleStateEnum = "FAILED"
)
var mappingListChannelsLifecycleStateEnum = map[string]ListChannelsLifecycleStateEnum{
"CREATING": ListChannelsLifecycleStateCreating,
"UPDATING": ListChannelsLifecycleStateUpdating,
"ACTIVE": ListChannelsLifecycleStateActive,
"INACTIVE": ListChannelsLifecycleStateInactive,
"DELETING": ListChannelsLifecycleStateDeleting,
"DELETED": ListChannelsLifecycleStateDeleted,
"FAILED": ListChannelsLifecycleStateFailed,
}
var mappingListChannelsLifecycleStateEnumLowerCase = map[string]ListChannelsLifecycleStateEnum{
"creating": ListChannelsLifecycleStateCreating,
"updating": ListChannelsLifecycleStateUpdating,
"active": ListChannelsLifecycleStateActive,
"inactive": ListChannelsLifecycleStateInactive,
"deleting": ListChannelsLifecycleStateDeleting,
"deleted": ListChannelsLifecycleStateDeleted,
"failed": ListChannelsLifecycleStateFailed,
}
// GetListChannelsLifecycleStateEnumValues Enumerates the set of values for ListChannelsLifecycleStateEnum
func GetListChannelsLifecycleStateEnumValues() []ListChannelsLifecycleStateEnum {
values := make([]ListChannelsLifecycleStateEnum, 0)
for _, v := range mappingListChannelsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListChannelsLifecycleStateEnumStringValues Enumerates the set of values in String for ListChannelsLifecycleStateEnum
func GetListChannelsLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"UPDATING",
"ACTIVE",
"INACTIVE",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingListChannelsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListChannelsLifecycleStateEnum(val string) (ListChannelsLifecycleStateEnum, bool) {
enum, ok := mappingListChannelsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListChannelsSortOrderEnum Enum with underlying type: string
type ListChannelsSortOrderEnum string
// Set of constants representing the allowable values for ListChannelsSortOrderEnum
const (
ListChannelsSortOrderAsc ListChannelsSortOrderEnum = "ASC"
ListChannelsSortOrderDesc ListChannelsSortOrderEnum = "DESC"
)
var mappingListChannelsSortOrderEnum = map[string]ListChannelsSortOrderEnum{
"ASC": ListChannelsSortOrderAsc,
"DESC": ListChannelsSortOrderDesc,
}
var mappingListChannelsSortOrderEnumLowerCase = map[string]ListChannelsSortOrderEnum{
"asc": ListChannelsSortOrderAsc,
"desc": ListChannelsSortOrderDesc,
}
// GetListChannelsSortOrderEnumValues Enumerates the set of values for ListChannelsSortOrderEnum
func GetListChannelsSortOrderEnumValues() []ListChannelsSortOrderEnum {
values := make([]ListChannelsSortOrderEnum, 0)
for _, v := range mappingListChannelsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListChannelsSortOrderEnumStringValues Enumerates the set of values in String for ListChannelsSortOrderEnum
func GetListChannelsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListChannelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListChannelsSortOrderEnum(val string) (ListChannelsSortOrderEnum, bool) {
enum, ok := mappingListChannelsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListChannelsSortByEnum Enum with underlying type: string
type ListChannelsSortByEnum string
// Set of constants representing the allowable values for ListChannelsSortByEnum
const (
ListChannelsSortByTimecreated ListChannelsSortByEnum = "timeCreated"
ListChannelsSortByTimeupdated ListChannelsSortByEnum = "timeUpdated"
ListChannelsSortByName ListChannelsSortByEnum = "name"
)
var mappingListChannelsSortByEnum = map[string]ListChannelsSortByEnum{
"timeCreated": ListChannelsSortByTimecreated,
"timeUpdated": ListChannelsSortByTimeupdated,
"name": ListChannelsSortByName,
}
var mappingListChannelsSortByEnumLowerCase = map[string]ListChannelsSortByEnum{
"timecreated": ListChannelsSortByTimecreated,
"timeupdated": ListChannelsSortByTimeupdated,
"name": ListChannelsSortByName,
}
// GetListChannelsSortByEnumValues Enumerates the set of values for ListChannelsSortByEnum
func GetListChannelsSortByEnumValues() []ListChannelsSortByEnum {
values := make([]ListChannelsSortByEnum, 0)
for _, v := range mappingListChannelsSortByEnum {
values = append(values, v)
}
return values
}
// GetListChannelsSortByEnumStringValues Enumerates the set of values in String for ListChannelsSortByEnum
func GetListChannelsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"timeUpdated",
"name",
}
}
// GetMappingListChannelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListChannelsSortByEnum(val string) (ListChannelsSortByEnum, bool) {
enum, ok := mappingListChannelsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}