/
list_assigned_subscriptions_request_response.go
251 lines (203 loc) · 11.4 KB
/
list_assigned_subscriptions_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
// 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 tenantmanagercontrolplane
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAssignedSubscriptionsRequest wrapper for the ListAssignedSubscriptions operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptions.go.html to see an example of how to use ListAssignedSubscriptionsRequest.
type ListAssignedSubscriptionsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the subscription to which the tenancy is associated.
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListAssignedSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListAssignedSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The version of the subscription entity.
EntityVersion ListAssignedSubscriptionsEntityVersionEnum `mandatory:"false" contributesTo:"query" name:"entityVersion" omitEmpty:"true"`
// 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 ListAssignedSubscriptionsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAssignedSubscriptionsRequest) 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 ListAssignedSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAssignedSubscriptionsRequest) 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 ListAssignedSubscriptionsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAssignedSubscriptionsSortOrderEnum(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(GetListAssignedSubscriptionsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListAssignedSubscriptionsSortByEnum(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(GetListAssignedSubscriptionsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAssignedSubscriptionsEntityVersionEnum(string(request.EntityVersion)); !ok && request.EntityVersion != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for EntityVersion: %s. Supported values are: %s.", request.EntityVersion, strings.Join(GetListAssignedSubscriptionsEntityVersionEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAssignedSubscriptionsResponse wrapper for the ListAssignedSubscriptions operation
type ListAssignedSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AssignedSubscriptionCollection instances
AssignedSubscriptionCollection `presentIn:"body"`
// 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"`
// 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 ListAssignedSubscriptionsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAssignedSubscriptionsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAssignedSubscriptionsSortOrderEnum Enum with underlying type: string
type ListAssignedSubscriptionsSortOrderEnum string
// Set of constants representing the allowable values for ListAssignedSubscriptionsSortOrderEnum
const (
ListAssignedSubscriptionsSortOrderAsc ListAssignedSubscriptionsSortOrderEnum = "ASC"
ListAssignedSubscriptionsSortOrderDesc ListAssignedSubscriptionsSortOrderEnum = "DESC"
)
var mappingListAssignedSubscriptionsSortOrderEnum = map[string]ListAssignedSubscriptionsSortOrderEnum{
"ASC": ListAssignedSubscriptionsSortOrderAsc,
"DESC": ListAssignedSubscriptionsSortOrderDesc,
}
var mappingListAssignedSubscriptionsSortOrderEnumLowerCase = map[string]ListAssignedSubscriptionsSortOrderEnum{
"asc": ListAssignedSubscriptionsSortOrderAsc,
"desc": ListAssignedSubscriptionsSortOrderDesc,
}
// GetListAssignedSubscriptionsSortOrderEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortOrderEnum
func GetListAssignedSubscriptionsSortOrderEnumValues() []ListAssignedSubscriptionsSortOrderEnum {
values := make([]ListAssignedSubscriptionsSortOrderEnum, 0)
for _, v := range mappingListAssignedSubscriptionsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAssignedSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortOrderEnum
func GetListAssignedSubscriptionsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAssignedSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAssignedSubscriptionsSortOrderEnum(val string) (ListAssignedSubscriptionsSortOrderEnum, bool) {
enum, ok := mappingListAssignedSubscriptionsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAssignedSubscriptionsSortByEnum Enum with underlying type: string
type ListAssignedSubscriptionsSortByEnum string
// Set of constants representing the allowable values for ListAssignedSubscriptionsSortByEnum
const (
ListAssignedSubscriptionsSortByTimecreated ListAssignedSubscriptionsSortByEnum = "timeCreated"
ListAssignedSubscriptionsSortByDisplayname ListAssignedSubscriptionsSortByEnum = "displayName"
)
var mappingListAssignedSubscriptionsSortByEnum = map[string]ListAssignedSubscriptionsSortByEnum{
"timeCreated": ListAssignedSubscriptionsSortByTimecreated,
"displayName": ListAssignedSubscriptionsSortByDisplayname,
}
var mappingListAssignedSubscriptionsSortByEnumLowerCase = map[string]ListAssignedSubscriptionsSortByEnum{
"timecreated": ListAssignedSubscriptionsSortByTimecreated,
"displayname": ListAssignedSubscriptionsSortByDisplayname,
}
// GetListAssignedSubscriptionsSortByEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortByEnum
func GetListAssignedSubscriptionsSortByEnumValues() []ListAssignedSubscriptionsSortByEnum {
values := make([]ListAssignedSubscriptionsSortByEnum, 0)
for _, v := range mappingListAssignedSubscriptionsSortByEnum {
values = append(values, v)
}
return values
}
// GetListAssignedSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortByEnum
func GetListAssignedSubscriptionsSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListAssignedSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAssignedSubscriptionsSortByEnum(val string) (ListAssignedSubscriptionsSortByEnum, bool) {
enum, ok := mappingListAssignedSubscriptionsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAssignedSubscriptionsEntityVersionEnum Enum with underlying type: string
type ListAssignedSubscriptionsEntityVersionEnum string
// Set of constants representing the allowable values for ListAssignedSubscriptionsEntityVersionEnum
const (
ListAssignedSubscriptionsEntityVersionV1 ListAssignedSubscriptionsEntityVersionEnum = "V1"
ListAssignedSubscriptionsEntityVersionV2 ListAssignedSubscriptionsEntityVersionEnum = "V2"
)
var mappingListAssignedSubscriptionsEntityVersionEnum = map[string]ListAssignedSubscriptionsEntityVersionEnum{
"V1": ListAssignedSubscriptionsEntityVersionV1,
"V2": ListAssignedSubscriptionsEntityVersionV2,
}
var mappingListAssignedSubscriptionsEntityVersionEnumLowerCase = map[string]ListAssignedSubscriptionsEntityVersionEnum{
"v1": ListAssignedSubscriptionsEntityVersionV1,
"v2": ListAssignedSubscriptionsEntityVersionV2,
}
// GetListAssignedSubscriptionsEntityVersionEnumValues Enumerates the set of values for ListAssignedSubscriptionsEntityVersionEnum
func GetListAssignedSubscriptionsEntityVersionEnumValues() []ListAssignedSubscriptionsEntityVersionEnum {
values := make([]ListAssignedSubscriptionsEntityVersionEnum, 0)
for _, v := range mappingListAssignedSubscriptionsEntityVersionEnum {
values = append(values, v)
}
return values
}
// GetListAssignedSubscriptionsEntityVersionEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsEntityVersionEnum
func GetListAssignedSubscriptionsEntityVersionEnumStringValues() []string {
return []string{
"V1",
"V2",
}
}
// GetMappingListAssignedSubscriptionsEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAssignedSubscriptionsEntityVersionEnum(val string) (ListAssignedSubscriptionsEntityVersionEnum, bool) {
enum, ok := mappingListAssignedSubscriptionsEntityVersionEnumLowerCase[strings.ToLower(val)]
return enum, ok
}