/
summarize_awr_db_wait_events_request_response.go
288 lines (231 loc) · 13.6 KB
/
summarize_awr_db_wait_events_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
// 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"
)
// SummarizeAwrDbWaitEventsRequest wrapper for the SummarizeAwrDbWaitEvents operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/databasemanagement/SummarizeAwrDbWaitEvents.go.html to see an example of how to use SummarizeAwrDbWaitEventsRequest.
type SummarizeAwrDbWaitEventsRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database.
ManagedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"managedDatabaseId"`
// The parameter to filter the database by internal ID.
// Note that the internal ID of the database can be retrieved from the following endpoint:
// /managedDatabases/{managedDatabaseId}/awrDbs
AwrDbId *string `mandatory:"true" contributesTo:"path" name:"awrDbId"`
// The optional single value query parameter to filter the database instance number.
InstNum *string `mandatory:"false" contributesTo:"query" name:"instNum"`
// The optional greater than or equal to filter on the snapshot ID.
BeginSnIdGreaterThanOrEqualTo *int `mandatory:"false" contributesTo:"query" name:"beginSnIdGreaterThanOrEqualTo"`
// The optional less than or equal to query parameter to filter the snapshot ID.
EndSnIdLessThanOrEqualTo *int `mandatory:"false" contributesTo:"query" name:"endSnIdLessThanOrEqualTo"`
// The optional greater than or equal to query parameter to filter the timestamp.
TimeGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeGreaterThanOrEqualTo"`
// The optional less than or equal to query parameter to filter the timestamp.
TimeLessThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeLessThanOrEqualTo"`
// The optional multiple value query parameter to filter the entity name.
Name []string `contributesTo:"query" name:"name" collectionFormat:"multi"`
// The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND.
SessionType SummarizeAwrDbWaitEventsSessionTypeEnum `mandatory:"false" contributesTo:"query" name:"sessionType" omitEmpty:"true"`
// The optional query parameter to filter the database container by an exact ID value.
// Note that the database container ID can be retrieved from the following endpoint:
// /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
ContainerId *int `mandatory:"false" contributesTo:"query" name:"containerId"`
// 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 large paginated response.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The option to sort the data within a time period.
SortBy SummarizeAwrDbWaitEventsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.
SortOrder SummarizeAwrDbWaitEventsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The OCID of the Named Credential.
OpcNamedCredentialId *string `mandatory:"false" contributesTo:"header" name:"opc-named-credential-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 SummarizeAwrDbWaitEventsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request SummarizeAwrDbWaitEventsRequest) 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 SummarizeAwrDbWaitEventsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeAwrDbWaitEventsRequest) 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 SummarizeAwrDbWaitEventsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingSummarizeAwrDbWaitEventsSessionTypeEnum(string(request.SessionType)); !ok && request.SessionType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SessionType: %s. Supported values are: %s.", request.SessionType, strings.Join(GetSummarizeAwrDbWaitEventsSessionTypeEnumStringValues(), ",")))
}
if _, ok := GetMappingSummarizeAwrDbWaitEventsSortByEnum(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(GetSummarizeAwrDbWaitEventsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingSummarizeAwrDbWaitEventsSortOrderEnum(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(GetSummarizeAwrDbWaitEventsSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// SummarizeAwrDbWaitEventsResponse wrapper for the SummarizeAwrDbWaitEvents operation
type SummarizeAwrDbWaitEventsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AwrDbWaitEventCollection instances
AwrDbWaitEventCollection `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 SummarizeAwrDbWaitEventsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response SummarizeAwrDbWaitEventsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// SummarizeAwrDbWaitEventsSessionTypeEnum Enum with underlying type: string
type SummarizeAwrDbWaitEventsSessionTypeEnum string
// Set of constants representing the allowable values for SummarizeAwrDbWaitEventsSessionTypeEnum
const (
SummarizeAwrDbWaitEventsSessionTypeForeground SummarizeAwrDbWaitEventsSessionTypeEnum = "FOREGROUND"
SummarizeAwrDbWaitEventsSessionTypeBackground SummarizeAwrDbWaitEventsSessionTypeEnum = "BACKGROUND"
SummarizeAwrDbWaitEventsSessionTypeAll SummarizeAwrDbWaitEventsSessionTypeEnum = "ALL"
)
var mappingSummarizeAwrDbWaitEventsSessionTypeEnum = map[string]SummarizeAwrDbWaitEventsSessionTypeEnum{
"FOREGROUND": SummarizeAwrDbWaitEventsSessionTypeForeground,
"BACKGROUND": SummarizeAwrDbWaitEventsSessionTypeBackground,
"ALL": SummarizeAwrDbWaitEventsSessionTypeAll,
}
var mappingSummarizeAwrDbWaitEventsSessionTypeEnumLowerCase = map[string]SummarizeAwrDbWaitEventsSessionTypeEnum{
"foreground": SummarizeAwrDbWaitEventsSessionTypeForeground,
"background": SummarizeAwrDbWaitEventsSessionTypeBackground,
"all": SummarizeAwrDbWaitEventsSessionTypeAll,
}
// GetSummarizeAwrDbWaitEventsSessionTypeEnumValues Enumerates the set of values for SummarizeAwrDbWaitEventsSessionTypeEnum
func GetSummarizeAwrDbWaitEventsSessionTypeEnumValues() []SummarizeAwrDbWaitEventsSessionTypeEnum {
values := make([]SummarizeAwrDbWaitEventsSessionTypeEnum, 0)
for _, v := range mappingSummarizeAwrDbWaitEventsSessionTypeEnum {
values = append(values, v)
}
return values
}
// GetSummarizeAwrDbWaitEventsSessionTypeEnumStringValues Enumerates the set of values in String for SummarizeAwrDbWaitEventsSessionTypeEnum
func GetSummarizeAwrDbWaitEventsSessionTypeEnumStringValues() []string {
return []string{
"FOREGROUND",
"BACKGROUND",
"ALL",
}
}
// GetMappingSummarizeAwrDbWaitEventsSessionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingSummarizeAwrDbWaitEventsSessionTypeEnum(val string) (SummarizeAwrDbWaitEventsSessionTypeEnum, bool) {
enum, ok := mappingSummarizeAwrDbWaitEventsSessionTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// SummarizeAwrDbWaitEventsSortByEnum Enum with underlying type: string
type SummarizeAwrDbWaitEventsSortByEnum string
// Set of constants representing the allowable values for SummarizeAwrDbWaitEventsSortByEnum
const (
SummarizeAwrDbWaitEventsSortByTimeBegin SummarizeAwrDbWaitEventsSortByEnum = "TIME_BEGIN"
SummarizeAwrDbWaitEventsSortByName SummarizeAwrDbWaitEventsSortByEnum = "NAME"
)
var mappingSummarizeAwrDbWaitEventsSortByEnum = map[string]SummarizeAwrDbWaitEventsSortByEnum{
"TIME_BEGIN": SummarizeAwrDbWaitEventsSortByTimeBegin,
"NAME": SummarizeAwrDbWaitEventsSortByName,
}
var mappingSummarizeAwrDbWaitEventsSortByEnumLowerCase = map[string]SummarizeAwrDbWaitEventsSortByEnum{
"time_begin": SummarizeAwrDbWaitEventsSortByTimeBegin,
"name": SummarizeAwrDbWaitEventsSortByName,
}
// GetSummarizeAwrDbWaitEventsSortByEnumValues Enumerates the set of values for SummarizeAwrDbWaitEventsSortByEnum
func GetSummarizeAwrDbWaitEventsSortByEnumValues() []SummarizeAwrDbWaitEventsSortByEnum {
values := make([]SummarizeAwrDbWaitEventsSortByEnum, 0)
for _, v := range mappingSummarizeAwrDbWaitEventsSortByEnum {
values = append(values, v)
}
return values
}
// GetSummarizeAwrDbWaitEventsSortByEnumStringValues Enumerates the set of values in String for SummarizeAwrDbWaitEventsSortByEnum
func GetSummarizeAwrDbWaitEventsSortByEnumStringValues() []string {
return []string{
"TIME_BEGIN",
"NAME",
}
}
// GetMappingSummarizeAwrDbWaitEventsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingSummarizeAwrDbWaitEventsSortByEnum(val string) (SummarizeAwrDbWaitEventsSortByEnum, bool) {
enum, ok := mappingSummarizeAwrDbWaitEventsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// SummarizeAwrDbWaitEventsSortOrderEnum Enum with underlying type: string
type SummarizeAwrDbWaitEventsSortOrderEnum string
// Set of constants representing the allowable values for SummarizeAwrDbWaitEventsSortOrderEnum
const (
SummarizeAwrDbWaitEventsSortOrderAsc SummarizeAwrDbWaitEventsSortOrderEnum = "ASC"
SummarizeAwrDbWaitEventsSortOrderDesc SummarizeAwrDbWaitEventsSortOrderEnum = "DESC"
)
var mappingSummarizeAwrDbWaitEventsSortOrderEnum = map[string]SummarizeAwrDbWaitEventsSortOrderEnum{
"ASC": SummarizeAwrDbWaitEventsSortOrderAsc,
"DESC": SummarizeAwrDbWaitEventsSortOrderDesc,
}
var mappingSummarizeAwrDbWaitEventsSortOrderEnumLowerCase = map[string]SummarizeAwrDbWaitEventsSortOrderEnum{
"asc": SummarizeAwrDbWaitEventsSortOrderAsc,
"desc": SummarizeAwrDbWaitEventsSortOrderDesc,
}
// GetSummarizeAwrDbWaitEventsSortOrderEnumValues Enumerates the set of values for SummarizeAwrDbWaitEventsSortOrderEnum
func GetSummarizeAwrDbWaitEventsSortOrderEnumValues() []SummarizeAwrDbWaitEventsSortOrderEnum {
values := make([]SummarizeAwrDbWaitEventsSortOrderEnum, 0)
for _, v := range mappingSummarizeAwrDbWaitEventsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetSummarizeAwrDbWaitEventsSortOrderEnumStringValues Enumerates the set of values in String for SummarizeAwrDbWaitEventsSortOrderEnum
func GetSummarizeAwrDbWaitEventsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingSummarizeAwrDbWaitEventsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingSummarizeAwrDbWaitEventsSortOrderEnum(val string) (SummarizeAwrDbWaitEventsSortOrderEnum, bool) {
enum, ok := mappingSummarizeAwrDbWaitEventsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}