/
list_vm_clusters_request_response.go
210 lines (168 loc) · 8.94 KB
/
list_vm_clusters_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
// 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 database
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListVmClustersRequest wrapper for the ListVmClusters operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/database/ListVmClusters.go.html to see an example of how to use ListVmClustersRequest.
type ListVmClustersRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// If provided, filters the results for the given Exadata Infrastructure.
ExadataInfrastructureId *string `mandatory:"false" contributesTo:"query" name:"exadataInfrastructureId"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token to continue listing from.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListVmClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListVmClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A filter to return only resources that match the given lifecycle state exactly.
LifecycleState VmClusterSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given. The match is not case sensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Unique identifier for the request.
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 ListVmClustersRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListVmClustersRequest) 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 ListVmClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVmClustersRequest) 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 ListVmClustersRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListVmClustersSortByEnum(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(GetListVmClustersSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListVmClustersSortOrderEnum(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(GetListVmClustersSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingVmClusterSummaryLifecycleStateEnum(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(GetVmClusterSummaryLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListVmClustersResponse wrapper for the ListVmClusters operation
type ListVmClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VmClusterSummary instances
Items []VmClusterSummary `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 there are additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListVmClustersResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListVmClustersResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListVmClustersSortByEnum Enum with underlying type: string
type ListVmClustersSortByEnum string
// Set of constants representing the allowable values for ListVmClustersSortByEnum
const (
ListVmClustersSortByTimecreated ListVmClustersSortByEnum = "TIMECREATED"
ListVmClustersSortByDisplayname ListVmClustersSortByEnum = "DISPLAYNAME"
)
var mappingListVmClustersSortByEnum = map[string]ListVmClustersSortByEnum{
"TIMECREATED": ListVmClustersSortByTimecreated,
"DISPLAYNAME": ListVmClustersSortByDisplayname,
}
var mappingListVmClustersSortByEnumLowerCase = map[string]ListVmClustersSortByEnum{
"timecreated": ListVmClustersSortByTimecreated,
"displayname": ListVmClustersSortByDisplayname,
}
// GetListVmClustersSortByEnumValues Enumerates the set of values for ListVmClustersSortByEnum
func GetListVmClustersSortByEnumValues() []ListVmClustersSortByEnum {
values := make([]ListVmClustersSortByEnum, 0)
for _, v := range mappingListVmClustersSortByEnum {
values = append(values, v)
}
return values
}
// GetListVmClustersSortByEnumStringValues Enumerates the set of values in String for ListVmClustersSortByEnum
func GetListVmClustersSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
}
}
// GetMappingListVmClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVmClustersSortByEnum(val string) (ListVmClustersSortByEnum, bool) {
enum, ok := mappingListVmClustersSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListVmClustersSortOrderEnum Enum with underlying type: string
type ListVmClustersSortOrderEnum string
// Set of constants representing the allowable values for ListVmClustersSortOrderEnum
const (
ListVmClustersSortOrderAsc ListVmClustersSortOrderEnum = "ASC"
ListVmClustersSortOrderDesc ListVmClustersSortOrderEnum = "DESC"
)
var mappingListVmClustersSortOrderEnum = map[string]ListVmClustersSortOrderEnum{
"ASC": ListVmClustersSortOrderAsc,
"DESC": ListVmClustersSortOrderDesc,
}
var mappingListVmClustersSortOrderEnumLowerCase = map[string]ListVmClustersSortOrderEnum{
"asc": ListVmClustersSortOrderAsc,
"desc": ListVmClustersSortOrderDesc,
}
// GetListVmClustersSortOrderEnumValues Enumerates the set of values for ListVmClustersSortOrderEnum
func GetListVmClustersSortOrderEnumValues() []ListVmClustersSortOrderEnum {
values := make([]ListVmClustersSortOrderEnum, 0)
for _, v := range mappingListVmClustersSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListVmClustersSortOrderEnumStringValues Enumerates the set of values in String for ListVmClustersSortOrderEnum
func GetListVmClustersSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListVmClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVmClustersSortOrderEnum(val string) (ListVmClustersSortOrderEnum, bool) {
enum, ok := mappingListVmClustersSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}