-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_external_asm_instances_request_response.go
206 lines (165 loc) · 9.26 KB
/
list_external_asm_instances_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
// 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 databasemanagement
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListExternalAsmInstancesRequest wrapper for the ListExternalAsmInstances operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/databasemanagement/ListExternalAsmInstances.go.html to see an example of how to use ListExternalAsmInstancesRequest.
type ListExternalAsmInstancesRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external ASM.
ExternalAsmId *string `mandatory:"false" contributesTo:"query" name:"externalAsmId"`
// A filter to only return the resources that match the entire display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The page token representing the page from where the next set of paginated results
// are retrieved. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of records returned in the paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort information by. Only one sortOrder can be used. The default sort order
// for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.
// The `DISPLAYNAME` sort order is case-sensitive.
SortBy ListExternalAsmInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.
SortOrder ListExternalAsmInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 ListExternalAsmInstancesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListExternalAsmInstancesRequest) 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 ListExternalAsmInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListExternalAsmInstancesRequest) 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 ListExternalAsmInstancesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListExternalAsmInstancesSortByEnum(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(GetListExternalAsmInstancesSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListExternalAsmInstancesSortOrderEnum(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(GetListExternalAsmInstancesSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListExternalAsmInstancesResponse wrapper for the ListExternalAsmInstances operation
type ListExternalAsmInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ExternalAsmInstanceCollection instances
ExternalAsmInstanceCollection `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 ListExternalAsmInstancesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListExternalAsmInstancesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListExternalAsmInstancesSortByEnum Enum with underlying type: string
type ListExternalAsmInstancesSortByEnum string
// Set of constants representing the allowable values for ListExternalAsmInstancesSortByEnum
const (
ListExternalAsmInstancesSortByTimecreated ListExternalAsmInstancesSortByEnum = "TIMECREATED"
ListExternalAsmInstancesSortByDisplayname ListExternalAsmInstancesSortByEnum = "DISPLAYNAME"
)
var mappingListExternalAsmInstancesSortByEnum = map[string]ListExternalAsmInstancesSortByEnum{
"TIMECREATED": ListExternalAsmInstancesSortByTimecreated,
"DISPLAYNAME": ListExternalAsmInstancesSortByDisplayname,
}
var mappingListExternalAsmInstancesSortByEnumLowerCase = map[string]ListExternalAsmInstancesSortByEnum{
"timecreated": ListExternalAsmInstancesSortByTimecreated,
"displayname": ListExternalAsmInstancesSortByDisplayname,
}
// GetListExternalAsmInstancesSortByEnumValues Enumerates the set of values for ListExternalAsmInstancesSortByEnum
func GetListExternalAsmInstancesSortByEnumValues() []ListExternalAsmInstancesSortByEnum {
values := make([]ListExternalAsmInstancesSortByEnum, 0)
for _, v := range mappingListExternalAsmInstancesSortByEnum {
values = append(values, v)
}
return values
}
// GetListExternalAsmInstancesSortByEnumStringValues Enumerates the set of values in String for ListExternalAsmInstancesSortByEnum
func GetListExternalAsmInstancesSortByEnumStringValues() []string {
return []string{
"TIMECREATED",
"DISPLAYNAME",
}
}
// GetMappingListExternalAsmInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListExternalAsmInstancesSortByEnum(val string) (ListExternalAsmInstancesSortByEnum, bool) {
enum, ok := mappingListExternalAsmInstancesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListExternalAsmInstancesSortOrderEnum Enum with underlying type: string
type ListExternalAsmInstancesSortOrderEnum string
// Set of constants representing the allowable values for ListExternalAsmInstancesSortOrderEnum
const (
ListExternalAsmInstancesSortOrderAsc ListExternalAsmInstancesSortOrderEnum = "ASC"
ListExternalAsmInstancesSortOrderDesc ListExternalAsmInstancesSortOrderEnum = "DESC"
)
var mappingListExternalAsmInstancesSortOrderEnum = map[string]ListExternalAsmInstancesSortOrderEnum{
"ASC": ListExternalAsmInstancesSortOrderAsc,
"DESC": ListExternalAsmInstancesSortOrderDesc,
}
var mappingListExternalAsmInstancesSortOrderEnumLowerCase = map[string]ListExternalAsmInstancesSortOrderEnum{
"asc": ListExternalAsmInstancesSortOrderAsc,
"desc": ListExternalAsmInstancesSortOrderDesc,
}
// GetListExternalAsmInstancesSortOrderEnumValues Enumerates the set of values for ListExternalAsmInstancesSortOrderEnum
func GetListExternalAsmInstancesSortOrderEnumValues() []ListExternalAsmInstancesSortOrderEnum {
values := make([]ListExternalAsmInstancesSortOrderEnum, 0)
for _, v := range mappingListExternalAsmInstancesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListExternalAsmInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListExternalAsmInstancesSortOrderEnum
func GetListExternalAsmInstancesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListExternalAsmInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListExternalAsmInstancesSortOrderEnum(val string) (ListExternalAsmInstancesSortOrderEnum, bool) {
enum, ok := mappingListExternalAsmInstancesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}