/
get_alarm_history_request_response.go
175 lines (142 loc) · 8.25 KB
/
get_alarm_history_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
// 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 monitoring
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// GetAlarmHistoryRequest wrapper for the GetAlarmHistory operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarmHistory.go.html to see an example of how to use GetAlarmHistoryRequest.
type GetAlarmHistoryRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
AlarmId *string `mandatory:"true" contributesTo:"path" name:"alarmId"`
// 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"`
// The type of history entries to retrieve.
// State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY).
// If not specified, entries of all types are retrieved.
// Example: `STATE_HISTORY`
AlarmHistorytype GetAlarmHistoryAlarmHistorytypeEnum `mandatory:"false" contributesTo:"query" name:"alarmHistorytype" omitEmpty:"true"`
// 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 alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.
// Example: `2023-01-01T01:00:00.789Z`
TimestampGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timestampGreaterThanOrEqualTo"`
// A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.
// Example: `2023-01-02T01:00:00.789Z`
TimestampLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timestampLessThan"`
// 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 GetAlarmHistoryRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request GetAlarmHistoryRequest) 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 GetAlarmHistoryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAlarmHistoryRequest) 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 GetAlarmHistoryRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingGetAlarmHistoryAlarmHistorytypeEnum(string(request.AlarmHistorytype)); !ok && request.AlarmHistorytype != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for AlarmHistorytype: %s. Supported values are: %s.", request.AlarmHistorytype, strings.Join(GetGetAlarmHistoryAlarmHistorytypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// GetAlarmHistoryResponse wrapper for the GetAlarmHistory operation
type GetAlarmHistoryResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AlarmHistoryCollection instances
AlarmHistoryCollection `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 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"`
}
func (response GetAlarmHistoryResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response GetAlarmHistoryResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// GetAlarmHistoryAlarmHistorytypeEnum Enum with underlying type: string
type GetAlarmHistoryAlarmHistorytypeEnum string
// Set of constants representing the allowable values for GetAlarmHistoryAlarmHistorytypeEnum
const (
GetAlarmHistoryAlarmHistorytypeStateHistory GetAlarmHistoryAlarmHistorytypeEnum = "STATE_HISTORY"
GetAlarmHistoryAlarmHistorytypeStateTransitionHistory GetAlarmHistoryAlarmHistorytypeEnum = "STATE_TRANSITION_HISTORY"
GetAlarmHistoryAlarmHistorytypeRuleHistory GetAlarmHistoryAlarmHistorytypeEnum = "RULE_HISTORY"
GetAlarmHistoryAlarmHistorytypeRuleTransitionHistory GetAlarmHistoryAlarmHistorytypeEnum = "RULE_TRANSITION_HISTORY"
)
var mappingGetAlarmHistoryAlarmHistorytypeEnum = map[string]GetAlarmHistoryAlarmHistorytypeEnum{
"STATE_HISTORY": GetAlarmHistoryAlarmHistorytypeStateHistory,
"STATE_TRANSITION_HISTORY": GetAlarmHistoryAlarmHistorytypeStateTransitionHistory,
"RULE_HISTORY": GetAlarmHistoryAlarmHistorytypeRuleHistory,
"RULE_TRANSITION_HISTORY": GetAlarmHistoryAlarmHistorytypeRuleTransitionHistory,
}
var mappingGetAlarmHistoryAlarmHistorytypeEnumLowerCase = map[string]GetAlarmHistoryAlarmHistorytypeEnum{
"state_history": GetAlarmHistoryAlarmHistorytypeStateHistory,
"state_transition_history": GetAlarmHistoryAlarmHistorytypeStateTransitionHistory,
"rule_history": GetAlarmHistoryAlarmHistorytypeRuleHistory,
"rule_transition_history": GetAlarmHistoryAlarmHistorytypeRuleTransitionHistory,
}
// GetGetAlarmHistoryAlarmHistorytypeEnumValues Enumerates the set of values for GetAlarmHistoryAlarmHistorytypeEnum
func GetGetAlarmHistoryAlarmHistorytypeEnumValues() []GetAlarmHistoryAlarmHistorytypeEnum {
values := make([]GetAlarmHistoryAlarmHistorytypeEnum, 0)
for _, v := range mappingGetAlarmHistoryAlarmHistorytypeEnum {
values = append(values, v)
}
return values
}
// GetGetAlarmHistoryAlarmHistorytypeEnumStringValues Enumerates the set of values in String for GetAlarmHistoryAlarmHistorytypeEnum
func GetGetAlarmHistoryAlarmHistorytypeEnumStringValues() []string {
return []string{
"STATE_HISTORY",
"STATE_TRANSITION_HISTORY",
"RULE_HISTORY",
"RULE_TRANSITION_HISTORY",
}
}
// GetMappingGetAlarmHistoryAlarmHistorytypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingGetAlarmHistoryAlarmHistorytypeEnum(val string) (GetAlarmHistoryAlarmHistorytypeEnum, bool) {
enum, ok := mappingGetAlarmHistoryAlarmHistorytypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}