forked from oracle/oci-go-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
alarm_summary.go
126 lines (104 loc) · 6.67 KB
/
alarm_summary.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
// 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.
// Monitoring API
//
// Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
// Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
// For information about monitoring, see Monitoring Overview (https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm).
//
package monitoring
import (
"github.com/oracle/oci-go-sdk/common"
)
// AlarmSummary A summary of properties for the specified alarm.
// For information about alarms, see Alarms Overview (https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
// talk to an administrator. If you're an administrator who needs to write policies to give users access, see
// Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
// For information about endpoints and signing API requests, see
// About the API (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see
// SDKS and Other Tools (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm).
type AlarmSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// This name is sent as the title for notifications related to this alarm.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric
// being evaluated by the alarm.
MetricCompartmentId *string `mandatory:"true" json:"metricCompartmentId"`
// The source service or application emitting the metric that is evaluated by the alarm.
// Example: `oci_computeagent`
Namespace *string `mandatory:"true" json:"namespace"`
// The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of
// the Monitoring service interprets results for each returned time series as Boolean values,
// where zero represents false and a non-zero value represents true. A true value means that the trigger
// rule condition has been met. The query must specify a metric, statistic, interval, and trigger
// rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally
// specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
// For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference (https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service.
// See Supported Services (https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
// Example of threshold alarm:
// -----
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85
// -----
// Example of absence alarm:
// -----
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
// -----
Query *string `mandatory:"true" json:"query"`
// The perceived severity of the alarm with regard to the affected system.
// Example: `CRITICAL`
Severity AlarmSummarySeverityEnum `mandatory:"true" json:"severity"`
// A list of destinations to which the notifications for this alarm will be delivered.
// Each destination is represented by an OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service.
// For example, a destination using the Notifications service is represented by a topic OCID.
// Supported destination services: Notifications Service. Limit: One destination per supported destination service.
Destinations []string `mandatory:"true" json:"destinations"`
// Whether the alarm is enabled.
// Example: `true`
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The current lifecycle state of the alarm.
// Example: `DELETED`
LifecycleState AlarmLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The configuration details for suppressing an alarm.
Suppression *Suppression `mandatory:"false" json:"suppression"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m AlarmSummary) String() string {
return common.PointerString(m)
}
// AlarmSummarySeverityEnum Enum with underlying type: string
type AlarmSummarySeverityEnum string
// Set of constants representing the allowable values for AlarmSummarySeverityEnum
const (
AlarmSummarySeverityCritical AlarmSummarySeverityEnum = "CRITICAL"
AlarmSummarySeverityError AlarmSummarySeverityEnum = "ERROR"
AlarmSummarySeverityWarning AlarmSummarySeverityEnum = "WARNING"
AlarmSummarySeverityInfo AlarmSummarySeverityEnum = "INFO"
)
var mappingAlarmSummarySeverity = map[string]AlarmSummarySeverityEnum{
"CRITICAL": AlarmSummarySeverityCritical,
"ERROR": AlarmSummarySeverityError,
"WARNING": AlarmSummarySeverityWarning,
"INFO": AlarmSummarySeverityInfo,
}
// GetAlarmSummarySeverityEnumValues Enumerates the set of values for AlarmSummarySeverityEnum
func GetAlarmSummarySeverityEnumValues() []AlarmSummarySeverityEnum {
values := make([]AlarmSummarySeverityEnum, 0)
for _, v := range mappingAlarmSummarySeverity {
values = append(values, v)
}
return values
}