-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_db_systems_request_response.go
277 lines (223 loc) · 12 KB
/
list_db_systems_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
// 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 mysql
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListDbSystemsRequest wrapper for the ListDbSystems operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/mysql/ListDbSystems.go.html to see an example of how to use ListDbSystemsRequest.
type ListDbSystemsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// If true, return only DB Systems with a HeatWave cluster attached, if false
// return only DB Systems with no HeatWave cluster attached. If not
// present, return all DB Systems.
IsHeatWaveClusterAttached *bool `mandatory:"false" contributesTo:"query" name:"isHeatWaveClusterAttached"`
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" contributesTo:"query" name:"dbSystemId"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// DbSystem Lifecycle State
LifecycleState DbSystemLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The requested Configuration instance.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// Filter instances if they are using the latest revision of the
// Configuration they are associated with.
IsUpToDate *bool `mandatory:"false" contributesTo:"query" name:"isUpToDate"`
// Filter DB Systems by their Database Management configuration.
DatabaseManagement []ListDbSystemsDatabaseManagementEnum `contributesTo:"query" name:"databaseManagement" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
SortBy ListDbSystemsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListDbSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListDbSystemsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListDbSystemsRequest) 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 ListDbSystemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDbSystemsRequest) 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 ListDbSystemsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingDbSystemLifecycleStateEnum(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(GetDbSystemLifecycleStateEnumStringValues(), ",")))
}
for _, val := range request.DatabaseManagement {
if _, ok := GetMappingListDbSystemsDatabaseManagementEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for DatabaseManagement: %s. Supported values are: %s.", val, strings.Join(GetListDbSystemsDatabaseManagementEnumStringValues(), ",")))
}
}
if _, ok := GetMappingListDbSystemsSortByEnum(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(GetListDbSystemsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListDbSystemsSortOrderEnum(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(GetListDbSystemsSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListDbSystemsResponse wrapper for the ListDbSystems operation
type ListDbSystemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []DbSystemSummary instances
Items []DbSystemSummary `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 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"`
}
func (response ListDbSystemsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListDbSystemsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListDbSystemsDatabaseManagementEnum Enum with underlying type: string
type ListDbSystemsDatabaseManagementEnum string
// Set of constants representing the allowable values for ListDbSystemsDatabaseManagementEnum
const (
ListDbSystemsDatabaseManagementEnabled ListDbSystemsDatabaseManagementEnum = "ENABLED"
ListDbSystemsDatabaseManagementDisabled ListDbSystemsDatabaseManagementEnum = "DISABLED"
)
var mappingListDbSystemsDatabaseManagementEnum = map[string]ListDbSystemsDatabaseManagementEnum{
"ENABLED": ListDbSystemsDatabaseManagementEnabled,
"DISABLED": ListDbSystemsDatabaseManagementDisabled,
}
var mappingListDbSystemsDatabaseManagementEnumLowerCase = map[string]ListDbSystemsDatabaseManagementEnum{
"enabled": ListDbSystemsDatabaseManagementEnabled,
"disabled": ListDbSystemsDatabaseManagementDisabled,
}
// GetListDbSystemsDatabaseManagementEnumValues Enumerates the set of values for ListDbSystemsDatabaseManagementEnum
func GetListDbSystemsDatabaseManagementEnumValues() []ListDbSystemsDatabaseManagementEnum {
values := make([]ListDbSystemsDatabaseManagementEnum, 0)
for _, v := range mappingListDbSystemsDatabaseManagementEnum {
values = append(values, v)
}
return values
}
// GetListDbSystemsDatabaseManagementEnumStringValues Enumerates the set of values in String for ListDbSystemsDatabaseManagementEnum
func GetListDbSystemsDatabaseManagementEnumStringValues() []string {
return []string{
"ENABLED",
"DISABLED",
}
}
// GetMappingListDbSystemsDatabaseManagementEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDbSystemsDatabaseManagementEnum(val string) (ListDbSystemsDatabaseManagementEnum, bool) {
enum, ok := mappingListDbSystemsDatabaseManagementEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDbSystemsSortByEnum Enum with underlying type: string
type ListDbSystemsSortByEnum string
// Set of constants representing the allowable values for ListDbSystemsSortByEnum
const (
ListDbSystemsSortByDisplayname ListDbSystemsSortByEnum = "displayName"
ListDbSystemsSortByTimecreated ListDbSystemsSortByEnum = "timeCreated"
)
var mappingListDbSystemsSortByEnum = map[string]ListDbSystemsSortByEnum{
"displayName": ListDbSystemsSortByDisplayname,
"timeCreated": ListDbSystemsSortByTimecreated,
}
var mappingListDbSystemsSortByEnumLowerCase = map[string]ListDbSystemsSortByEnum{
"displayname": ListDbSystemsSortByDisplayname,
"timecreated": ListDbSystemsSortByTimecreated,
}
// GetListDbSystemsSortByEnumValues Enumerates the set of values for ListDbSystemsSortByEnum
func GetListDbSystemsSortByEnumValues() []ListDbSystemsSortByEnum {
values := make([]ListDbSystemsSortByEnum, 0)
for _, v := range mappingListDbSystemsSortByEnum {
values = append(values, v)
}
return values
}
// GetListDbSystemsSortByEnumStringValues Enumerates the set of values in String for ListDbSystemsSortByEnum
func GetListDbSystemsSortByEnumStringValues() []string {
return []string{
"displayName",
"timeCreated",
}
}
// GetMappingListDbSystemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDbSystemsSortByEnum(val string) (ListDbSystemsSortByEnum, bool) {
enum, ok := mappingListDbSystemsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListDbSystemsSortOrderEnum Enum with underlying type: string
type ListDbSystemsSortOrderEnum string
// Set of constants representing the allowable values for ListDbSystemsSortOrderEnum
const (
ListDbSystemsSortOrderAsc ListDbSystemsSortOrderEnum = "ASC"
ListDbSystemsSortOrderDesc ListDbSystemsSortOrderEnum = "DESC"
)
var mappingListDbSystemsSortOrderEnum = map[string]ListDbSystemsSortOrderEnum{
"ASC": ListDbSystemsSortOrderAsc,
"DESC": ListDbSystemsSortOrderDesc,
}
var mappingListDbSystemsSortOrderEnumLowerCase = map[string]ListDbSystemsSortOrderEnum{
"asc": ListDbSystemsSortOrderAsc,
"desc": ListDbSystemsSortOrderDesc,
}
// GetListDbSystemsSortOrderEnumValues Enumerates the set of values for ListDbSystemsSortOrderEnum
func GetListDbSystemsSortOrderEnumValues() []ListDbSystemsSortOrderEnum {
values := make([]ListDbSystemsSortOrderEnum, 0)
for _, v := range mappingListDbSystemsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListDbSystemsSortOrderEnumStringValues Enumerates the set of values in String for ListDbSystemsSortOrderEnum
func GetListDbSystemsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListDbSystemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListDbSystemsSortOrderEnum(val string) (ListDbSystemsSortOrderEnum, bool) {
enum, ok := mappingListDbSystemsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}