/
list_gateways_request_response.go
222 lines (179 loc) · 9.02 KB
/
list_gateways_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
// 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 apigateway
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListGatewaysRequest wrapper for the ListGateways operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/ListGateways.go.html to see an example of how to use ListGatewaysRequest.
type ListGatewaysRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter gateways by the certificate ocid.
CertificateId *string `mandatory:"false" contributesTo:"query" name:"certificateId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `SUCCEEDED`
LifecycleState GatewayLifecycleStateEnum `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'. The default order depends on the sortBy value.
SortOrder ListGatewaysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListGatewaysSortByEnum `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 ListGatewaysRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListGatewaysRequest) 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 ListGatewaysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGatewaysRequest) 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 ListGatewaysRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingGatewayLifecycleStateEnum(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(GetGatewayLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListGatewaysSortOrderEnum(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(GetListGatewaysSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListGatewaysSortByEnum(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(GetListGatewaysSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListGatewaysResponse wrapper for the ListGateways operation
type ListGatewaysResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GatewayCollection instances
GatewayCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results remain. For important details about how
// pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListGatewaysResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListGatewaysResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListGatewaysSortOrderEnum Enum with underlying type: string
type ListGatewaysSortOrderEnum string
// Set of constants representing the allowable values for ListGatewaysSortOrderEnum
const (
ListGatewaysSortOrderAsc ListGatewaysSortOrderEnum = "ASC"
ListGatewaysSortOrderDesc ListGatewaysSortOrderEnum = "DESC"
)
var mappingListGatewaysSortOrderEnum = map[string]ListGatewaysSortOrderEnum{
"ASC": ListGatewaysSortOrderAsc,
"DESC": ListGatewaysSortOrderDesc,
}
var mappingListGatewaysSortOrderEnumLowerCase = map[string]ListGatewaysSortOrderEnum{
"asc": ListGatewaysSortOrderAsc,
"desc": ListGatewaysSortOrderDesc,
}
// GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum
func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum {
values := make([]ListGatewaysSortOrderEnum, 0)
for _, v := range mappingListGatewaysSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListGatewaysSortOrderEnumStringValues Enumerates the set of values in String for ListGatewaysSortOrderEnum
func GetListGatewaysSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListGatewaysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListGatewaysSortOrderEnum(val string) (ListGatewaysSortOrderEnum, bool) {
enum, ok := mappingListGatewaysSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListGatewaysSortByEnum Enum with underlying type: string
type ListGatewaysSortByEnum string
// Set of constants representing the allowable values for ListGatewaysSortByEnum
const (
ListGatewaysSortByTimecreated ListGatewaysSortByEnum = "timeCreated"
ListGatewaysSortByDisplayname ListGatewaysSortByEnum = "displayName"
)
var mappingListGatewaysSortByEnum = map[string]ListGatewaysSortByEnum{
"timeCreated": ListGatewaysSortByTimecreated,
"displayName": ListGatewaysSortByDisplayname,
}
var mappingListGatewaysSortByEnumLowerCase = map[string]ListGatewaysSortByEnum{
"timecreated": ListGatewaysSortByTimecreated,
"displayname": ListGatewaysSortByDisplayname,
}
// GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum
func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum {
values := make([]ListGatewaysSortByEnum, 0)
for _, v := range mappingListGatewaysSortByEnum {
values = append(values, v)
}
return values
}
// GetListGatewaysSortByEnumStringValues Enumerates the set of values in String for ListGatewaysSortByEnum
func GetListGatewaysSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
}
}
// GetMappingListGatewaysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListGatewaysSortByEnum(val string) (ListGatewaysSortByEnum, bool) {
enum, ok := mappingListGatewaysSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}