/
list_rover_entitlements_request_response.go
270 lines (220 loc) · 12.2 KB
/
list_rover_entitlements_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
// 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 rover
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListRoverEntitlementsRequest wrapper for the ListRoverEntitlements operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/rover/ListRoverEntitlements.go.html to see an example of how to use ListRoverEntitlementsRequest.
type ListRoverEntitlementsRequest struct {
// The OCID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// filtering by Rover Device Entitlement id
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListRoverEntitlementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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 sort order to use, either 'asc' or 'desc'.
SortOrder ListRoverEntitlementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListRoverEntitlementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListRoverEntitlementsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListRoverEntitlementsRequest) 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 ListRoverEntitlementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRoverEntitlementsRequest) 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 ListRoverEntitlementsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListRoverEntitlementsLifecycleStateEnum(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(GetListRoverEntitlementsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListRoverEntitlementsSortOrderEnum(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(GetListRoverEntitlementsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListRoverEntitlementsSortByEnum(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(GetListRoverEntitlementsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListRoverEntitlementsResponse wrapper for the ListRoverEntitlements operation
type ListRoverEntitlementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RoverEntitlementCollection instances
RoverEntitlementCollection `presentIn:"body"`
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRoverEntitlementsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListRoverEntitlementsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListRoverEntitlementsLifecycleStateEnum Enum with underlying type: string
type ListRoverEntitlementsLifecycleStateEnum string
// Set of constants representing the allowable values for ListRoverEntitlementsLifecycleStateEnum
const (
ListRoverEntitlementsLifecycleStateCreating ListRoverEntitlementsLifecycleStateEnum = "CREATING"
ListRoverEntitlementsLifecycleStateUpdating ListRoverEntitlementsLifecycleStateEnum = "UPDATING"
ListRoverEntitlementsLifecycleStateActive ListRoverEntitlementsLifecycleStateEnum = "ACTIVE"
ListRoverEntitlementsLifecycleStateDeleting ListRoverEntitlementsLifecycleStateEnum = "DELETING"
ListRoverEntitlementsLifecycleStateDeleted ListRoverEntitlementsLifecycleStateEnum = "DELETED"
ListRoverEntitlementsLifecycleStateFailed ListRoverEntitlementsLifecycleStateEnum = "FAILED"
)
var mappingListRoverEntitlementsLifecycleStateEnum = map[string]ListRoverEntitlementsLifecycleStateEnum{
"CREATING": ListRoverEntitlementsLifecycleStateCreating,
"UPDATING": ListRoverEntitlementsLifecycleStateUpdating,
"ACTIVE": ListRoverEntitlementsLifecycleStateActive,
"DELETING": ListRoverEntitlementsLifecycleStateDeleting,
"DELETED": ListRoverEntitlementsLifecycleStateDeleted,
"FAILED": ListRoverEntitlementsLifecycleStateFailed,
}
var mappingListRoverEntitlementsLifecycleStateEnumLowerCase = map[string]ListRoverEntitlementsLifecycleStateEnum{
"creating": ListRoverEntitlementsLifecycleStateCreating,
"updating": ListRoverEntitlementsLifecycleStateUpdating,
"active": ListRoverEntitlementsLifecycleStateActive,
"deleting": ListRoverEntitlementsLifecycleStateDeleting,
"deleted": ListRoverEntitlementsLifecycleStateDeleted,
"failed": ListRoverEntitlementsLifecycleStateFailed,
}
// GetListRoverEntitlementsLifecycleStateEnumValues Enumerates the set of values for ListRoverEntitlementsLifecycleStateEnum
func GetListRoverEntitlementsLifecycleStateEnumValues() []ListRoverEntitlementsLifecycleStateEnum {
values := make([]ListRoverEntitlementsLifecycleStateEnum, 0)
for _, v := range mappingListRoverEntitlementsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListRoverEntitlementsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsLifecycleStateEnum
func GetListRoverEntitlementsLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"UPDATING",
"ACTIVE",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingListRoverEntitlementsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRoverEntitlementsLifecycleStateEnum(val string) (ListRoverEntitlementsLifecycleStateEnum, bool) {
enum, ok := mappingListRoverEntitlementsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRoverEntitlementsSortOrderEnum Enum with underlying type: string
type ListRoverEntitlementsSortOrderEnum string
// Set of constants representing the allowable values for ListRoverEntitlementsSortOrderEnum
const (
ListRoverEntitlementsSortOrderAsc ListRoverEntitlementsSortOrderEnum = "ASC"
ListRoverEntitlementsSortOrderDesc ListRoverEntitlementsSortOrderEnum = "DESC"
)
var mappingListRoverEntitlementsSortOrderEnum = map[string]ListRoverEntitlementsSortOrderEnum{
"ASC": ListRoverEntitlementsSortOrderAsc,
"DESC": ListRoverEntitlementsSortOrderDesc,
}
var mappingListRoverEntitlementsSortOrderEnumLowerCase = map[string]ListRoverEntitlementsSortOrderEnum{
"asc": ListRoverEntitlementsSortOrderAsc,
"desc": ListRoverEntitlementsSortOrderDesc,
}
// GetListRoverEntitlementsSortOrderEnumValues Enumerates the set of values for ListRoverEntitlementsSortOrderEnum
func GetListRoverEntitlementsSortOrderEnumValues() []ListRoverEntitlementsSortOrderEnum {
values := make([]ListRoverEntitlementsSortOrderEnum, 0)
for _, v := range mappingListRoverEntitlementsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListRoverEntitlementsSortOrderEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsSortOrderEnum
func GetListRoverEntitlementsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListRoverEntitlementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRoverEntitlementsSortOrderEnum(val string) (ListRoverEntitlementsSortOrderEnum, bool) {
enum, ok := mappingListRoverEntitlementsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRoverEntitlementsSortByEnum Enum with underlying type: string
type ListRoverEntitlementsSortByEnum string
// Set of constants representing the allowable values for ListRoverEntitlementsSortByEnum
const (
ListRoverEntitlementsSortByTimecreated ListRoverEntitlementsSortByEnum = "timeCreated"
ListRoverEntitlementsSortByDisplayname ListRoverEntitlementsSortByEnum = "displayName"
)
var mappingListRoverEntitlementsSortByEnum = map[string]ListRoverEntitlementsSortByEnum{
"timeCreated": ListRoverEntitlementsSortByTimecreated,
"displayName": ListRoverEntitlementsSortByDisplayname,
}
var mappingListRoverEntitlementsSortByEnumLowerCase = map[string]ListRoverEntitlementsSortByEnum{
"timecreated": ListRoverEntitlementsSortByTimecreated,
"displayname": ListRoverEntitlementsSortByDisplayname,
}
// GetListRoverEntitlementsSortByEnumValues Enumerates the set of values for ListRoverEntitlementsSortByEnum
func GetListRoverEntitlementsSortByEnumValues() []ListRoverEntitlementsSortByEnum {
values := make([]ListRoverEntitlementsSortByEnum, 0)
for _, v := range mappingListRoverEntitlementsSortByEnum {
values = append(values, v)
}
return values
}
// GetListRoverEntitlementsSortByEnumStringValues Enumerates the set of values in String for ListRoverEntitlementsSortByEnum
func GetListRoverEntitlementsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListRoverEntitlementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRoverEntitlementsSortByEnum(val string) (ListRoverEntitlementsSortByEnum, bool) {
enum, ok := mappingListRoverEntitlementsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}