-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_rules_request_response.go
317 lines (258 loc) · 12.6 KB
/
list_rules_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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
// 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 loganalytics
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListRulesRequest wrapper for the ListRules operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/loganalytics/ListRules.go.html to see an example of how to use ListRulesRequest.
type ListRulesRequest struct {
// The Logging Analytics namespace used for the request.
NamespaceName *string `mandatory:"true" contributesTo:"path" name:"namespaceName"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return rules whose displayName matches in whole or in part the
// specified value. The match is case-insensitive.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The rule kind used for filtering. Only rules of the specified
// kind will be returned.
Kind ListRulesKindEnum `mandatory:"false" contributesTo:"query" name:"kind" omitEmpty:"true"`
// The target service to use for filtering.
TargetService *string `mandatory:"false" contributesTo:"query" name:"targetService"`
// The rule lifecycle state used for filtering. Currently supported
// values are ACTIVE and DELETED.
LifecycleState ListRulesLifecycleStateEnum `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 ascending (`ASC`) or descending (`DESC`).
SortOrder ListRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListRulesSortByEnum `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 ListRulesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListRulesRequest) 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 ListRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRulesRequest) 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 ListRulesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListRulesKindEnum(string(request.Kind)); !ok && request.Kind != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Kind: %s. Supported values are: %s.", request.Kind, strings.Join(GetListRulesKindEnumStringValues(), ",")))
}
if _, ok := GetMappingListRulesLifecycleStateEnum(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(GetListRulesLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListRulesSortOrderEnum(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(GetListRulesSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListRulesSortByEnum(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(GetListRulesSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListRulesResponse wrapper for the ListRules operation
type ListRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RuleSummaryCollection instances
RuleSummaryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
// subsequent request to get the previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, 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 additional items may be available on the next page of the list. Include this value as the `page` parameter for the
// subsequent request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRulesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListRulesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListRulesKindEnum Enum with underlying type: string
type ListRulesKindEnum string
// Set of constants representing the allowable values for ListRulesKindEnum
const (
ListRulesKindIngestTime ListRulesKindEnum = "INGEST_TIME"
ListRulesKindSavedSearch ListRulesKindEnum = "SAVED_SEARCH"
ListRulesKindAll ListRulesKindEnum = "ALL"
)
var mappingListRulesKindEnum = map[string]ListRulesKindEnum{
"INGEST_TIME": ListRulesKindIngestTime,
"SAVED_SEARCH": ListRulesKindSavedSearch,
"ALL": ListRulesKindAll,
}
var mappingListRulesKindEnumLowerCase = map[string]ListRulesKindEnum{
"ingest_time": ListRulesKindIngestTime,
"saved_search": ListRulesKindSavedSearch,
"all": ListRulesKindAll,
}
// GetListRulesKindEnumValues Enumerates the set of values for ListRulesKindEnum
func GetListRulesKindEnumValues() []ListRulesKindEnum {
values := make([]ListRulesKindEnum, 0)
for _, v := range mappingListRulesKindEnum {
values = append(values, v)
}
return values
}
// GetListRulesKindEnumStringValues Enumerates the set of values in String for ListRulesKindEnum
func GetListRulesKindEnumStringValues() []string {
return []string{
"INGEST_TIME",
"SAVED_SEARCH",
"ALL",
}
}
// GetMappingListRulesKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRulesKindEnum(val string) (ListRulesKindEnum, bool) {
enum, ok := mappingListRulesKindEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRulesLifecycleStateEnum Enum with underlying type: string
type ListRulesLifecycleStateEnum string
// Set of constants representing the allowable values for ListRulesLifecycleStateEnum
const (
ListRulesLifecycleStateActive ListRulesLifecycleStateEnum = "ACTIVE"
ListRulesLifecycleStateDeleted ListRulesLifecycleStateEnum = "DELETED"
)
var mappingListRulesLifecycleStateEnum = map[string]ListRulesLifecycleStateEnum{
"ACTIVE": ListRulesLifecycleStateActive,
"DELETED": ListRulesLifecycleStateDeleted,
}
var mappingListRulesLifecycleStateEnumLowerCase = map[string]ListRulesLifecycleStateEnum{
"active": ListRulesLifecycleStateActive,
"deleted": ListRulesLifecycleStateDeleted,
}
// GetListRulesLifecycleStateEnumValues Enumerates the set of values for ListRulesLifecycleStateEnum
func GetListRulesLifecycleStateEnumValues() []ListRulesLifecycleStateEnum {
values := make([]ListRulesLifecycleStateEnum, 0)
for _, v := range mappingListRulesLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListRulesLifecycleStateEnumStringValues Enumerates the set of values in String for ListRulesLifecycleStateEnum
func GetListRulesLifecycleStateEnumStringValues() []string {
return []string{
"ACTIVE",
"DELETED",
}
}
// GetMappingListRulesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRulesLifecycleStateEnum(val string) (ListRulesLifecycleStateEnum, bool) {
enum, ok := mappingListRulesLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRulesSortOrderEnum Enum with underlying type: string
type ListRulesSortOrderEnum string
// Set of constants representing the allowable values for ListRulesSortOrderEnum
const (
ListRulesSortOrderAsc ListRulesSortOrderEnum = "ASC"
ListRulesSortOrderDesc ListRulesSortOrderEnum = "DESC"
)
var mappingListRulesSortOrderEnum = map[string]ListRulesSortOrderEnum{
"ASC": ListRulesSortOrderAsc,
"DESC": ListRulesSortOrderDesc,
}
var mappingListRulesSortOrderEnumLowerCase = map[string]ListRulesSortOrderEnum{
"asc": ListRulesSortOrderAsc,
"desc": ListRulesSortOrderDesc,
}
// GetListRulesSortOrderEnumValues Enumerates the set of values for ListRulesSortOrderEnum
func GetListRulesSortOrderEnumValues() []ListRulesSortOrderEnum {
values := make([]ListRulesSortOrderEnum, 0)
for _, v := range mappingListRulesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListRulesSortOrderEnumStringValues Enumerates the set of values in String for ListRulesSortOrderEnum
func GetListRulesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRulesSortOrderEnum(val string) (ListRulesSortOrderEnum, bool) {
enum, ok := mappingListRulesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListRulesSortByEnum Enum with underlying type: string
type ListRulesSortByEnum string
// Set of constants representing the allowable values for ListRulesSortByEnum
const (
ListRulesSortByTimecreated ListRulesSortByEnum = "timeCreated"
ListRulesSortByTimeupdated ListRulesSortByEnum = "timeUpdated"
ListRulesSortByDisplayname ListRulesSortByEnum = "displayName"
)
var mappingListRulesSortByEnum = map[string]ListRulesSortByEnum{
"timeCreated": ListRulesSortByTimecreated,
"timeUpdated": ListRulesSortByTimeupdated,
"displayName": ListRulesSortByDisplayname,
}
var mappingListRulesSortByEnumLowerCase = map[string]ListRulesSortByEnum{
"timecreated": ListRulesSortByTimecreated,
"timeupdated": ListRulesSortByTimeupdated,
"displayname": ListRulesSortByDisplayname,
}
// GetListRulesSortByEnumValues Enumerates the set of values for ListRulesSortByEnum
func GetListRulesSortByEnumValues() []ListRulesSortByEnum {
values := make([]ListRulesSortByEnum, 0)
for _, v := range mappingListRulesSortByEnum {
values = append(values, v)
}
return values
}
// GetListRulesSortByEnumStringValues Enumerates the set of values in String for ListRulesSortByEnum
func GetListRulesSortByEnumStringValues() []string {
return []string{
"timeCreated",
"timeUpdated",
"displayName",
}
}
// GetMappingListRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListRulesSortByEnum(val string) (ListRulesSortByEnum, bool) {
enum, ok := mappingListRulesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}