-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_notebook_sessions_request_response.go
288 lines (236 loc) · 13.5 KB
/
list_notebook_sessions_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
// 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 datascience
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListNotebookSessionsRequest wrapper for the ListNotebookSessions operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datascience/ListNotebookSessions.go.html to see an example of how to use ListNotebookSessionsRequest.
type ListNotebookSessionsRequest struct {
// <b>Filter</b> results by the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// <b>Filter</b> results by OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// <b>Filter</b> results by the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// <b>Filter</b> results by its user-friendly name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// <b>Filter</b> results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ListNotebookSessionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// <b>Filter</b> results by the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.
CreatedBy *string `mandatory:"false" contributesTo:"query" name:"createdBy"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// See List Pagination (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).
// Example: `500`
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.
// See List Pagination (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
SortOrder ListNotebookSessionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field.
// By default, when you sort by `timeCreated`, the results are shown
// in descending order. When you sort by `displayName`, results are
// shown in ascending order. Sort order for the `displayName` field is case sensitive.
SortBy ListNotebookSessionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.
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 ListNotebookSessionsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListNotebookSessionsRequest) 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 ListNotebookSessionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNotebookSessionsRequest) 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 ListNotebookSessionsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListNotebookSessionsLifecycleStateEnum(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(GetListNotebookSessionsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListNotebookSessionsSortOrderEnum(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(GetListNotebookSessionsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListNotebookSessionsSortByEnum(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(GetListNotebookSessionsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListNotebookSessionsResponse wrapper for the ListNotebookSessions operation
type ListNotebookSessionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NotebookSessionSummary instances
Items []NotebookSessionSummary `presentIn:"body"`
// 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"`
// Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// Unique Oracle assigned identifier for the request. If you need to contact
// Oracle about a particular request, then provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListNotebookSessionsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListNotebookSessionsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListNotebookSessionsLifecycleStateEnum Enum with underlying type: string
type ListNotebookSessionsLifecycleStateEnum string
// Set of constants representing the allowable values for ListNotebookSessionsLifecycleStateEnum
const (
ListNotebookSessionsLifecycleStateCreating ListNotebookSessionsLifecycleStateEnum = "CREATING"
ListNotebookSessionsLifecycleStateActive ListNotebookSessionsLifecycleStateEnum = "ACTIVE"
ListNotebookSessionsLifecycleStateDeleting ListNotebookSessionsLifecycleStateEnum = "DELETING"
ListNotebookSessionsLifecycleStateDeleted ListNotebookSessionsLifecycleStateEnum = "DELETED"
ListNotebookSessionsLifecycleStateFailed ListNotebookSessionsLifecycleStateEnum = "FAILED"
ListNotebookSessionsLifecycleStateInactive ListNotebookSessionsLifecycleStateEnum = "INACTIVE"
ListNotebookSessionsLifecycleStateUpdating ListNotebookSessionsLifecycleStateEnum = "UPDATING"
)
var mappingListNotebookSessionsLifecycleStateEnum = map[string]ListNotebookSessionsLifecycleStateEnum{
"CREATING": ListNotebookSessionsLifecycleStateCreating,
"ACTIVE": ListNotebookSessionsLifecycleStateActive,
"DELETING": ListNotebookSessionsLifecycleStateDeleting,
"DELETED": ListNotebookSessionsLifecycleStateDeleted,
"FAILED": ListNotebookSessionsLifecycleStateFailed,
"INACTIVE": ListNotebookSessionsLifecycleStateInactive,
"UPDATING": ListNotebookSessionsLifecycleStateUpdating,
}
var mappingListNotebookSessionsLifecycleStateEnumLowerCase = map[string]ListNotebookSessionsLifecycleStateEnum{
"creating": ListNotebookSessionsLifecycleStateCreating,
"active": ListNotebookSessionsLifecycleStateActive,
"deleting": ListNotebookSessionsLifecycleStateDeleting,
"deleted": ListNotebookSessionsLifecycleStateDeleted,
"failed": ListNotebookSessionsLifecycleStateFailed,
"inactive": ListNotebookSessionsLifecycleStateInactive,
"updating": ListNotebookSessionsLifecycleStateUpdating,
}
// GetListNotebookSessionsLifecycleStateEnumValues Enumerates the set of values for ListNotebookSessionsLifecycleStateEnum
func GetListNotebookSessionsLifecycleStateEnumValues() []ListNotebookSessionsLifecycleStateEnum {
values := make([]ListNotebookSessionsLifecycleStateEnum, 0)
for _, v := range mappingListNotebookSessionsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListNotebookSessionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListNotebookSessionsLifecycleStateEnum
func GetListNotebookSessionsLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"ACTIVE",
"DELETING",
"DELETED",
"FAILED",
"INACTIVE",
"UPDATING",
}
}
// GetMappingListNotebookSessionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListNotebookSessionsLifecycleStateEnum(val string) (ListNotebookSessionsLifecycleStateEnum, bool) {
enum, ok := mappingListNotebookSessionsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListNotebookSessionsSortOrderEnum Enum with underlying type: string
type ListNotebookSessionsSortOrderEnum string
// Set of constants representing the allowable values for ListNotebookSessionsSortOrderEnum
const (
ListNotebookSessionsSortOrderAsc ListNotebookSessionsSortOrderEnum = "ASC"
ListNotebookSessionsSortOrderDesc ListNotebookSessionsSortOrderEnum = "DESC"
)
var mappingListNotebookSessionsSortOrderEnum = map[string]ListNotebookSessionsSortOrderEnum{
"ASC": ListNotebookSessionsSortOrderAsc,
"DESC": ListNotebookSessionsSortOrderDesc,
}
var mappingListNotebookSessionsSortOrderEnumLowerCase = map[string]ListNotebookSessionsSortOrderEnum{
"asc": ListNotebookSessionsSortOrderAsc,
"desc": ListNotebookSessionsSortOrderDesc,
}
// GetListNotebookSessionsSortOrderEnumValues Enumerates the set of values for ListNotebookSessionsSortOrderEnum
func GetListNotebookSessionsSortOrderEnumValues() []ListNotebookSessionsSortOrderEnum {
values := make([]ListNotebookSessionsSortOrderEnum, 0)
for _, v := range mappingListNotebookSessionsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListNotebookSessionsSortOrderEnumStringValues Enumerates the set of values in String for ListNotebookSessionsSortOrderEnum
func GetListNotebookSessionsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListNotebookSessionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListNotebookSessionsSortOrderEnum(val string) (ListNotebookSessionsSortOrderEnum, bool) {
enum, ok := mappingListNotebookSessionsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListNotebookSessionsSortByEnum Enum with underlying type: string
type ListNotebookSessionsSortByEnum string
// Set of constants representing the allowable values for ListNotebookSessionsSortByEnum
const (
ListNotebookSessionsSortByTimecreated ListNotebookSessionsSortByEnum = "timeCreated"
ListNotebookSessionsSortByDisplayname ListNotebookSessionsSortByEnum = "displayName"
)
var mappingListNotebookSessionsSortByEnum = map[string]ListNotebookSessionsSortByEnum{
"timeCreated": ListNotebookSessionsSortByTimecreated,
"displayName": ListNotebookSessionsSortByDisplayname,
}
var mappingListNotebookSessionsSortByEnumLowerCase = map[string]ListNotebookSessionsSortByEnum{
"timecreated": ListNotebookSessionsSortByTimecreated,
"displayname": ListNotebookSessionsSortByDisplayname,
}
// GetListNotebookSessionsSortByEnumValues Enumerates the set of values for ListNotebookSessionsSortByEnum
func GetListNotebookSessionsSortByEnumValues() []ListNotebookSessionsSortByEnum {
values := make([]ListNotebookSessionsSortByEnum, 0)
for _, v := range mappingListNotebookSessionsSortByEnum {
values = append(values, v)
}
return values
}
// GetListNotebookSessionsSortByEnumStringValues Enumerates the set of values in String for ListNotebookSessionsSortByEnum
func GetListNotebookSessionsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListNotebookSessionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListNotebookSessionsSortByEnum(val string) (ListNotebookSessionsSortByEnum, bool) {
enum, ok := mappingListNotebookSessionsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}