forked from oracle/oci-go-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
list_alarms_request_response.go
147 lines (116 loc) · 6.52 KB
/
list_alarms_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
// Copyright (c) 2016, 2018, 2020, 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 monitoring
import (
"github.com/oracle/oci-go-sdk/common"
"net/http"
)
// ListAlarmsRequest wrapper for the ListAlarms operation
type ListAlarmsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the
// resources monitored by the metric that you are searching for. Use tenancyId to search in
// the root compartment.
// Example: `ocid1.compartment.oc1..exampleuniqueID`
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer part of the request identifier token. If you need to contact Oracle about a particular
// request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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/iaas/Content/API/Concepts/usingapi.htm#nine).
// Default: 1000
// Example: 500
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A filter to return only resources that match the given display name exactly.
// Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
LifecycleState AlarmLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field to use when sorting returned alarm definitions. Only one sorting level is provided.
// Example: `severity`
SortBy ListAlarmsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).
// Example: `ASC`
SortOrder ListAlarmsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// When true, returns resources from all compartments and subcompartments. The parameter can
// only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).
// A true value requires the user to have tenancy-level permissions. If this requirement is not met,
// then the call is rejected. When false, returns resources from only the compartment specified in
// compartmentId. Default is false.
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 ListAlarmsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAlarmsRequest) HTTPRequest(method, path string) (http.Request, error) {
return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAlarmsRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// ListAlarmsResponse wrapper for the ListAlarms operation
type ListAlarmsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AlarmSummary instances
Items []AlarmSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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"`
}
func (response ListAlarmsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAlarmsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAlarmsSortByEnum Enum with underlying type: string
type ListAlarmsSortByEnum string
// Set of constants representing the allowable values for ListAlarmsSortByEnum
const (
ListAlarmsSortByDisplayname ListAlarmsSortByEnum = "displayName"
ListAlarmsSortBySeverity ListAlarmsSortByEnum = "severity"
)
var mappingListAlarmsSortBy = map[string]ListAlarmsSortByEnum{
"displayName": ListAlarmsSortByDisplayname,
"severity": ListAlarmsSortBySeverity,
}
// GetListAlarmsSortByEnumValues Enumerates the set of values for ListAlarmsSortByEnum
func GetListAlarmsSortByEnumValues() []ListAlarmsSortByEnum {
values := make([]ListAlarmsSortByEnum, 0)
for _, v := range mappingListAlarmsSortBy {
values = append(values, v)
}
return values
}
// ListAlarmsSortOrderEnum Enum with underlying type: string
type ListAlarmsSortOrderEnum string
// Set of constants representing the allowable values for ListAlarmsSortOrderEnum
const (
ListAlarmsSortOrderAsc ListAlarmsSortOrderEnum = "ASC"
ListAlarmsSortOrderDesc ListAlarmsSortOrderEnum = "DESC"
)
var mappingListAlarmsSortOrder = map[string]ListAlarmsSortOrderEnum{
"ASC": ListAlarmsSortOrderAsc,
"DESC": ListAlarmsSortOrderDesc,
}
// GetListAlarmsSortOrderEnumValues Enumerates the set of values for ListAlarmsSortOrderEnum
func GetListAlarmsSortOrderEnumValues() []ListAlarmsSortOrderEnum {
values := make([]ListAlarmsSortOrderEnum, 0)
for _, v := range mappingListAlarmsSortOrder {
values = append(values, v)
}
return values
}