/
list_addm_db_recommendation_categories_request_response.go
234 lines (188 loc) · 12.3 KB
/
list_addm_db_recommendation_categories_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
// 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 opsi
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAddmDbRecommendationCategoriesRequest wrapper for the ListAddmDbRecommendationCategories operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/opsi/ListAddmDbRecommendationCategories.go.html to see an example of how to use ListAddmDbRecommendationCategoriesRequest.
type ListAddmDbRecommendationCategoriesRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Optional list of database OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.
DatabaseId []string `contributesTo:"query" name:"databaseId" collectionFormat:"multi"`
// Optional list of database insight resource OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// For list pagination. The maximum number of results per page, or items to
// return in a paginated "List" call.
// For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from
// the previous "List" call. For important details about how pagination works,
// see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListAddmDbRecommendationCategoriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Field name for sorting the recommendation categories
SortBy ListAddmDbRecommendationCategoriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.
// Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive.
// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagEquals []string `contributesTo:"query" name:"definedTagEquals" collectionFormat:"multi"`
// A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.
// The key for each tag is "{tagName}.{value}". All inputs are case-insensitive.
// Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
FreeformTagEquals []string `contributesTo:"query" name:"freeformTagEquals" collectionFormat:"multi"`
// A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.
// Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)
// or "{namespace}.true". All inputs are case-insensitive.
// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagExists []string `contributesTo:"query" name:"definedTagExists" collectionFormat:"multi"`
// A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.
// The key for each tag is "{tagName}.true". All inputs are case-insensitive.
// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
// Multiple values for different tag names are interpreted as "AND".
FreeformTagExists []string `contributesTo:"query" name:"freeformTagExists" collectionFormat:"multi"`
// A flag to search all resources within a given compartment and all sub-compartments.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// 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 ListAddmDbRecommendationCategoriesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAddmDbRecommendationCategoriesRequest) 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 ListAddmDbRecommendationCategoriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAddmDbRecommendationCategoriesRequest) 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 ListAddmDbRecommendationCategoriesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAddmDbRecommendationCategoriesSortOrderEnum(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(GetListAddmDbRecommendationCategoriesSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListAddmDbRecommendationCategoriesSortByEnum(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(GetListAddmDbRecommendationCategoriesSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAddmDbRecommendationCategoriesResponse wrapper for the ListAddmDbRecommendationCategories operation
type ListAddmDbRecommendationCategoriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AddmDbRecommendationCategoryCollection instances
AddmDbRecommendationCategoryCollection `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 ListAddmDbRecommendationCategoriesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAddmDbRecommendationCategoriesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAddmDbRecommendationCategoriesSortOrderEnum Enum with underlying type: string
type ListAddmDbRecommendationCategoriesSortOrderEnum string
// Set of constants representing the allowable values for ListAddmDbRecommendationCategoriesSortOrderEnum
const (
ListAddmDbRecommendationCategoriesSortOrderAsc ListAddmDbRecommendationCategoriesSortOrderEnum = "ASC"
ListAddmDbRecommendationCategoriesSortOrderDesc ListAddmDbRecommendationCategoriesSortOrderEnum = "DESC"
)
var mappingListAddmDbRecommendationCategoriesSortOrderEnum = map[string]ListAddmDbRecommendationCategoriesSortOrderEnum{
"ASC": ListAddmDbRecommendationCategoriesSortOrderAsc,
"DESC": ListAddmDbRecommendationCategoriesSortOrderDesc,
}
var mappingListAddmDbRecommendationCategoriesSortOrderEnumLowerCase = map[string]ListAddmDbRecommendationCategoriesSortOrderEnum{
"asc": ListAddmDbRecommendationCategoriesSortOrderAsc,
"desc": ListAddmDbRecommendationCategoriesSortOrderDesc,
}
// GetListAddmDbRecommendationCategoriesSortOrderEnumValues Enumerates the set of values for ListAddmDbRecommendationCategoriesSortOrderEnum
func GetListAddmDbRecommendationCategoriesSortOrderEnumValues() []ListAddmDbRecommendationCategoriesSortOrderEnum {
values := make([]ListAddmDbRecommendationCategoriesSortOrderEnum, 0)
for _, v := range mappingListAddmDbRecommendationCategoriesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAddmDbRecommendationCategoriesSortOrderEnumStringValues Enumerates the set of values in String for ListAddmDbRecommendationCategoriesSortOrderEnum
func GetListAddmDbRecommendationCategoriesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAddmDbRecommendationCategoriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAddmDbRecommendationCategoriesSortOrderEnum(val string) (ListAddmDbRecommendationCategoriesSortOrderEnum, bool) {
enum, ok := mappingListAddmDbRecommendationCategoriesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAddmDbRecommendationCategoriesSortByEnum Enum with underlying type: string
type ListAddmDbRecommendationCategoriesSortByEnum string
// Set of constants representing the allowable values for ListAddmDbRecommendationCategoriesSortByEnum
const (
ListAddmDbRecommendationCategoriesSortByName ListAddmDbRecommendationCategoriesSortByEnum = "name"
)
var mappingListAddmDbRecommendationCategoriesSortByEnum = map[string]ListAddmDbRecommendationCategoriesSortByEnum{
"name": ListAddmDbRecommendationCategoriesSortByName,
}
var mappingListAddmDbRecommendationCategoriesSortByEnumLowerCase = map[string]ListAddmDbRecommendationCategoriesSortByEnum{
"name": ListAddmDbRecommendationCategoriesSortByName,
}
// GetListAddmDbRecommendationCategoriesSortByEnumValues Enumerates the set of values for ListAddmDbRecommendationCategoriesSortByEnum
func GetListAddmDbRecommendationCategoriesSortByEnumValues() []ListAddmDbRecommendationCategoriesSortByEnum {
values := make([]ListAddmDbRecommendationCategoriesSortByEnum, 0)
for _, v := range mappingListAddmDbRecommendationCategoriesSortByEnum {
values = append(values, v)
}
return values
}
// GetListAddmDbRecommendationCategoriesSortByEnumStringValues Enumerates the set of values in String for ListAddmDbRecommendationCategoriesSortByEnum
func GetListAddmDbRecommendationCategoriesSortByEnumStringValues() []string {
return []string{
"name",
}
}
// GetMappingListAddmDbRecommendationCategoriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAddmDbRecommendationCategoriesSortByEnum(val string) (ListAddmDbRecommendationCategoriesSortByEnum, bool) {
enum, ok := mappingListAddmDbRecommendationCategoriesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}