/
list_runs_request_response.go
317 lines (263 loc) · 13 KB
/
list_runs_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
// 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 dataflow
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListRunsRequest wrapper for the ListRuns operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dataflow/ListRuns.go.html to see an example of how to use ListRunsRequest.
type ListRunsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique identifier for the request. If provided, the returned request ID will include this value.
// Otherwise, a random request ID will be generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The ID of the application.
ApplicationId *string `mandatory:"false" contributesTo:"query" name:"applicationId"`
// The ID of the pool.
PoolId *string `mandatory:"false" contributesTo:"query" name:"poolId"`
// The OCID of the user who created the resource.
OwnerPrincipalId *string `mandatory:"false" contributesTo:"query" name:"ownerPrincipalId"`
// The displayName prefix.
DisplayNameStartsWith *string `mandatory:"false" contributesTo:"query" name:"displayNameStartsWith"`
// The LifecycleState of the run.
LifecycleState ListRunsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The epoch time that the resource was created.
TimeCreatedGreaterThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThan"`
// The maximum number of results to return in a paginated `List` call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
// to sent back to server for getting the next page of results.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field used to sort the results. Multiple fields are not supported.
SortBy ListRunsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The ordering of results in ascending or descending order.
SortOrder ListRunsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The query parameter for the Spark application name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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 ListRunsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListRunsRequest) 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 ListRunsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRunsRequest) 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 ListRunsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListRunsLifecycleStateEnum(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(GetListRunsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListRunsSortByEnum(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(GetListRunsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListRunsSortOrderEnum(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(GetListRunsSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListRunsResponse wrapper for the ListRuns operation
type ListRunsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []RunSummary instances
Items []RunSummary `presentIn:"body"`
// 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"`
// 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"`
// 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 ListRunsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListRunsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListRunsLifecycleStateEnum Enum with underlying type: string
type ListRunsLifecycleStateEnum string
// Set of constants representing the allowable values for ListRunsLifecycleStateEnum
const (
ListRunsLifecycleStateAccepted ListRunsLifecycleStateEnum = "ACCEPTED"
ListRunsLifecycleStateInProgress ListRunsLifecycleStateEnum = "IN_PROGRESS"
ListRunsLifecycleStateCanceling ListRunsLifecycleStateEnum = "CANCELING"
ListRunsLifecycleStateCanceled ListRunsLifecycleStateEnum = "CANCELED"
ListRunsLifecycleStateFailed ListRunsLifecycleStateEnum = "FAILED"
ListRunsLifecycleStateSucceeded ListRunsLifecycleStateEnum = "SUCCEEDED"
ListRunsLifecycleStateStopping ListRunsLifecycleStateEnum = "STOPPING"
ListRunsLifecycleStateStopped ListRunsLifecycleStateEnum = "STOPPED"
)
var mappingListRunsLifecycleStateEnum = map[string]ListRunsLifecycleStateEnum{
"ACCEPTED": ListRunsLifecycleStateAccepted,
"IN_PROGRESS": ListRunsLifecycleStateInProgress,
"CANCELING": ListRunsLifecycleStateCanceling,
"CANCELED": ListRunsLifecycleStateCanceled,
"FAILED": ListRunsLifecycleStateFailed,
"SUCCEEDED": ListRunsLifecycleStateSucceeded,
"STOPPING": ListRunsLifecycleStateStopping,
"STOPPED": ListRunsLifecycleStateStopped,
}
var mappingListRunsLifecycleStateEnumLowerCase = map[string]ListRunsLifecycleStateEnum{
"accepted": ListRunsLifecycleStateAccepted,
"in_progress": ListRunsLifecycleStateInProgress,
"canceling": ListRunsLifecycleStateCanceling,
"canceled": ListRunsLifecycleStateCanceled,
"failed": ListRunsLifecycleStateFailed,
"succeeded": ListRunsLifecycleStateSucceeded,
"stopping": ListRunsLifecycleStateStopping,
"stopped": ListRunsLifecycleStateStopped,
}
// GetListRunsLifecycleStateEnumValues Enumerates the set of values for ListRunsLifecycleStateEnum
func GetListRunsLifecycleStateEnumValues() []ListRunsLifecycleStateEnum {
values := make([]ListRunsLifecycleStateEnum, 0)
for _, v := range mappingListRunsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListRunsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRunsLifecycleStateEnum
func GetListRunsLifecycleStateEnumStringValues() []string {
return []string{
"ACCEPTED",
"IN_PROGRESS",
"CANCELING",
"CANCELED",
"FAILED",
"SUCCEEDED",
"STOPPING",
"STOPPED",
}
}
// GetMappingListRunsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRunsLifecycleStateEnum(val string) (ListRunsLifecycleStateEnum, bool) {
enum, ok := mappingListRunsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRunsSortByEnum Enum with underlying type: string
type ListRunsSortByEnum string
// Set of constants representing the allowable values for ListRunsSortByEnum
const (
ListRunsSortByTimecreated ListRunsSortByEnum = "timeCreated"
ListRunsSortByDisplayname ListRunsSortByEnum = "displayName"
ListRunsSortByLanguage ListRunsSortByEnum = "language"
ListRunsSortByRundurationinmilliseconds ListRunsSortByEnum = "runDurationInMilliseconds"
ListRunsSortByLifecyclestate ListRunsSortByEnum = "lifecycleState"
ListRunsSortByTotalocpu ListRunsSortByEnum = "totalOCpu"
ListRunsSortByDatareadinbytes ListRunsSortByEnum = "dataReadInBytes"
ListRunsSortByDatawritteninbytes ListRunsSortByEnum = "dataWrittenInBytes"
)
var mappingListRunsSortByEnum = map[string]ListRunsSortByEnum{
"timeCreated": ListRunsSortByTimecreated,
"displayName": ListRunsSortByDisplayname,
"language": ListRunsSortByLanguage,
"runDurationInMilliseconds": ListRunsSortByRundurationinmilliseconds,
"lifecycleState": ListRunsSortByLifecyclestate,
"totalOCpu": ListRunsSortByTotalocpu,
"dataReadInBytes": ListRunsSortByDatareadinbytes,
"dataWrittenInBytes": ListRunsSortByDatawritteninbytes,
}
var mappingListRunsSortByEnumLowerCase = map[string]ListRunsSortByEnum{
"timecreated": ListRunsSortByTimecreated,
"displayname": ListRunsSortByDisplayname,
"language": ListRunsSortByLanguage,
"rundurationinmilliseconds": ListRunsSortByRundurationinmilliseconds,
"lifecyclestate": ListRunsSortByLifecyclestate,
"totalocpu": ListRunsSortByTotalocpu,
"datareadinbytes": ListRunsSortByDatareadinbytes,
"datawritteninbytes": ListRunsSortByDatawritteninbytes,
}
// GetListRunsSortByEnumValues Enumerates the set of values for ListRunsSortByEnum
func GetListRunsSortByEnumValues() []ListRunsSortByEnum {
values := make([]ListRunsSortByEnum, 0)
for _, v := range mappingListRunsSortByEnum {
values = append(values, v)
}
return values
}
// GetListRunsSortByEnumStringValues Enumerates the set of values in String for ListRunsSortByEnum
func GetListRunsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
"language",
"runDurationInMilliseconds",
"lifecycleState",
"totalOCpu",
"dataReadInBytes",
"dataWrittenInBytes",
}
}
// GetMappingListRunsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRunsSortByEnum(val string) (ListRunsSortByEnum, bool) {
enum, ok := mappingListRunsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRunsSortOrderEnum Enum with underlying type: string
type ListRunsSortOrderEnum string
// Set of constants representing the allowable values for ListRunsSortOrderEnum
const (
ListRunsSortOrderAsc ListRunsSortOrderEnum = "ASC"
ListRunsSortOrderDesc ListRunsSortOrderEnum = "DESC"
)
var mappingListRunsSortOrderEnum = map[string]ListRunsSortOrderEnum{
"ASC": ListRunsSortOrderAsc,
"DESC": ListRunsSortOrderDesc,
}
var mappingListRunsSortOrderEnumLowerCase = map[string]ListRunsSortOrderEnum{
"asc": ListRunsSortOrderAsc,
"desc": ListRunsSortOrderDesc,
}
// GetListRunsSortOrderEnumValues Enumerates the set of values for ListRunsSortOrderEnum
func GetListRunsSortOrderEnumValues() []ListRunsSortOrderEnum {
values := make([]ListRunsSortOrderEnum, 0)
for _, v := range mappingListRunsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListRunsSortOrderEnumStringValues Enumerates the set of values in String for ListRunsSortOrderEnum
func GetListRunsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListRunsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRunsSortOrderEnum(val string) (ListRunsSortOrderEnum, bool) {
enum, ok := mappingListRunsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}