func GetAlarmDimensionStatesEntryStatusEnumStringValues() []string
GetAlarmDimensionStatesEntryStatusEnumStringValues Enumerates the set of values in String for AlarmDimensionStatesEntryStatusEnum
func GetAlarmLifecycleStateEnumStringValues() []string
GetAlarmLifecycleStateEnumStringValues Enumerates the set of values in String for AlarmLifecycleStateEnum
func GetAlarmMessageFormatEnumStringValues() []string
GetAlarmMessageFormatEnumStringValues Enumerates the set of values in String for AlarmMessageFormatEnum
func GetAlarmSeverityEnumStringValues() []string
GetAlarmSeverityEnumStringValues Enumerates the set of values in String for AlarmSeverityEnum
func GetAlarmStatusSummarySeverityEnumStringValues() []string
GetAlarmStatusSummarySeverityEnumStringValues Enumerates the set of values in String for AlarmStatusSummarySeverityEnum
func GetAlarmStatusSummaryStatusEnumStringValues() []string
GetAlarmStatusSummaryStatusEnumStringValues Enumerates the set of values in String for AlarmStatusSummaryStatusEnum
func GetAlarmSummarySeverityEnumStringValues() []string
GetAlarmSummarySeverityEnumStringValues Enumerates the set of values in String for AlarmSummarySeverityEnum
func GetAlarmSuppressionHistoryItemLevelEnumStringValues() []string
GetAlarmSuppressionHistoryItemLevelEnumStringValues Enumerates the set of values in String for AlarmSuppressionHistoryItemLevelEnum
func GetAlarmSuppressionLevelEnumStringValues() []string
GetAlarmSuppressionLevelEnumStringValues Enumerates the set of values in String for AlarmSuppressionLevelEnum
func GetAlarmSuppressionLifecycleStateEnumStringValues() []string
GetAlarmSuppressionLifecycleStateEnumStringValues Enumerates the set of values in String for AlarmSuppressionLifecycleStateEnum
func GetAlarmSuppressionTargetTargetTypeEnumStringValues() []string
GetAlarmSuppressionTargetTargetTypeEnumStringValues Enumerates the set of values in String for AlarmSuppressionTargetTargetTypeEnum
func GetCreateAlarmDetailsMessageFormatEnumStringValues() []string
GetCreateAlarmDetailsMessageFormatEnumStringValues Enumerates the set of values in String for CreateAlarmDetailsMessageFormatEnum
func GetGetAlarmHistoryAlarmHistorytypeEnumStringValues() []string
GetGetAlarmHistoryAlarmHistorytypeEnumStringValues Enumerates the set of values in String for GetAlarmHistoryAlarmHistorytypeEnum
func GetListAlarmSuppressionsSortByEnumStringValues() []string
GetListAlarmSuppressionsSortByEnumStringValues Enumerates the set of values in String for ListAlarmSuppressionsSortByEnum
func GetListAlarmSuppressionsSortOrderEnumStringValues() []string
GetListAlarmSuppressionsSortOrderEnumStringValues Enumerates the set of values in String for ListAlarmSuppressionsSortOrderEnum
func GetListAlarmSuppressionsTargetTypeEnumStringValues() []string
GetListAlarmSuppressionsTargetTypeEnumStringValues Enumerates the set of values in String for ListAlarmSuppressionsTargetTypeEnum
func GetListAlarmsSortByEnumStringValues() []string
GetListAlarmsSortByEnumStringValues Enumerates the set of values in String for ListAlarmsSortByEnum
func GetListAlarmsSortOrderEnumStringValues() []string
GetListAlarmsSortOrderEnumStringValues Enumerates the set of values in String for ListAlarmsSortOrderEnum
func GetListAlarmsStatusSortByEnumStringValues() []string
GetListAlarmsStatusSortByEnumStringValues Enumerates the set of values in String for ListAlarmsStatusSortByEnum
func GetListAlarmsStatusSortOrderEnumStringValues() []string
GetListAlarmsStatusSortOrderEnumStringValues Enumerates the set of values in String for ListAlarmsStatusSortOrderEnum
func GetListAlarmsStatusStatusEnumStringValues() []string
GetListAlarmsStatusStatusEnumStringValues Enumerates the set of values in String for ListAlarmsStatusStatusEnum
func GetListMetricsDetailsSortByEnumStringValues() []string
GetListMetricsDetailsSortByEnumStringValues Enumerates the set of values in String for ListMetricsDetailsSortByEnum
func GetListMetricsDetailsSortOrderEnumStringValues() []string
GetListMetricsDetailsSortOrderEnumStringValues Enumerates the set of values in String for ListMetricsDetailsSortOrderEnum
func GetPostMetricDataDetailsBatchAtomicityEnumStringValues() []string
GetPostMetricDataDetailsBatchAtomicityEnumStringValues Enumerates the set of values in String for PostMetricDataDetailsBatchAtomicityEnum
func GetSuppressionConditionConditionTypeEnumStringValues() []string
GetSuppressionConditionConditionTypeEnumStringValues Enumerates the set of values in String for SuppressionConditionConditionTypeEnum
func GetUpdateAlarmDetailsMessageFormatEnumStringValues() []string
GetUpdateAlarmDetailsMessageFormatEnumStringValues Enumerates the set of values in String for UpdateAlarmDetailsMessageFormatEnum
AggregatedDatapoint A timestamp-value pair returned for the specified request.
type AggregatedDatapoint struct {
// The date and time associated with the value of this data point. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Numeric value of the metric.
// Example: `10.4`
Value *float64 `mandatory:"true" json:"value"`
}
func (m AggregatedDatapoint) String() string
func (m AggregatedDatapoint) ValidateEnumValue() (bool, error)
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
Alarm The properties that define an alarm. For information about alarms, see Alarms Overview (https://docs.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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see About the API (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see SDKS and Other Tools (https://docs.oracle.com/iaas/Content/API/Concepts/sdks.htm).
type Alarm struct {
// The OCID (https://docs.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.
// This value determines the title of each alarm notification.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.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 depend on the specified time range. More
// interval values are supported for smaller time ranges. You can optionally
// specify dimensions and grouping functions.
// Also, you can customize the
// absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm).
// Supported grouping functions: `grouping()`, `groupBy()`.
// For information about writing MQL expressions, see
// Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm).
// For details about MQL, see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.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()
// -----
// Example of absence alarm with custom absence detection period of 20 hours:
// -----
//
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)
//
// -----
Query *string `mandatory:"true" json:"query"`
// The perceived type of response required when the alarm is in the "FIRING" state.
// Example: `CRITICAL`
Severity AlarmSeverityEnum `mandatory:"true" json:"severity"`
// A list of destinations for alarm notifications.
// Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
// of a related resource, such as a NotificationTopic.
// Supported destination services: Notifications, Streaming.
// 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 date and time the alarm was created. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the alarm was last updated. Format defined by RFC3339.
// Example: `2023-02-03T01:02:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can
// only be set to true when metricCompartmentId 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, the alarm evaluates metrics from only the compartment specified
// in metricCompartmentId. Default is false.
// Example: `true`
MetricCompartmentIdInSubtree *bool `mandatory:"false" json:"metricCompartmentIdInSubtree"`
// Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The time between calculated aggregation windows for the alarm. Supported value: `1m`
Resolution *string `mandatory:"false" json:"resolution"`
// The period of time that the condition defined in the alarm must persist before the alarm state
// changes from "OK" to "FIRING". For example, a value of 5 minutes means that the
// alarm must persist in breaching the condition for five minutes before the alarm updates its
// state to "FIRING".
// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
// Under the default value of PT1M, the first evaluation that breaches the alarm updates the
// state to "FIRING".
// The alarm updates its status to "OK" when the breaching condition has been clear for
// the most recent minute.
// Example: `PT5M`
PendingDuration *string `mandatory:"false" json:"pendingDuration"`
// The human-readable content of the delivered alarm notification.
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// Oracle recommends providing guidance
// to operators for resolving the alarm condition. Consider adding links to standard runbook
// practices. Avoid entering confidential information.
// Example: `High CPU usage alert. Follow runbook instructions for resolution.`
Body *string `mandatory:"false" json:"body"`
// When set to `true`, splits alarm notifications per metric stream.
// When set to `false`, groups alarm notifications across metric streams.
IsNotificationsPerMetricDimensionEnabled *bool `mandatory:"false" json:"isNotificationsPerMetricDimensionEnabled"`
// The format to use for alarm notifications. The formats are:
// * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format.
// * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only.
// * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only.
MessageFormat AlarmMessageFormatEnum `mandatory:"false" json:"messageFormat,omitempty"`
// The frequency for re-submitting alarm notifications, if the alarm keeps firing without
// interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours.
// Minimum: PT1M. Maximum: P30D.
// Default value: null (notifications are not re-submitted).
// Example: `PT2H`
RepeatNotificationDuration *string `mandatory:"false" json:"repeatNotificationDuration"`
// 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"`
// A set of overrides that control evaluations of the alarm.
// Each override can specify values for query, severity, body, and pending duration.
// When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
// and then evaluates the alarm's base values (`ruleName` value of `BASE`).
Overrides []AlarmOverride `mandatory:"false" json:"overrides"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"false" json:"ruleName"`
// The version of the alarm notification to be delivered. Allowed value: `1.X`
// The value must start with a number (up to four digits), followed by a period and an uppercase X.
NotificationVersion *string `mandatory:"false" json:"notificationVersion"`
// Customizable notification title (`title` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
NotificationTitle *string `mandatory:"false" json:"notificationTitle"`
// Customizable slack period to wait for metric ingestion before evaluating the alarm.
// Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M.
// For more information about the slack period, see
// About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
EvaluationSlackDuration *string `mandatory:"false" json:"evaluationSlackDuration"`
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"false" json:"alarmSummary"`
}
func (m Alarm) String() string
func (m Alarm) ValidateEnumValue() (bool, error)
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
AlarmDimensionStatesCollection The list of current alarm state entries for each metric stream that matches the filters.
type AlarmDimensionStatesCollection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm to retrieve alarm state entries for.
AlarmId *string `mandatory:"true" json:"alarmId"`
// Whether the alarm is enabled.
// Example: `true`
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// When set to `true`, splits alarm notifications per metric stream.
// When set to `false`, groups alarm notifications across metric streams.
IsNotificationsPerMetricDimensionEnabled *bool `mandatory:"true" json:"isNotificationsPerMetricDimensionEnabled"`
// Array of alarm state entries.
Items []AlarmDimensionStatesEntry `mandatory:"true" json:"items"`
}
func (m AlarmDimensionStatesCollection) String() string
func (m AlarmDimensionStatesCollection) ValidateEnumValue() (bool, error)
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
AlarmDimensionStatesEntry A timestamped alarm state entry for a metric stream.
type AlarmDimensionStatesEntry struct {
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"true" json:"alarmSummary"`
// Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs.
Dimensions map[string]string `mandatory:"true" json:"dimensions"`
// Transition state (status value) associated with the alarm state entry.
// Example: `FIRING`
Status AlarmDimensionStatesEntryStatusEnum `mandatory:"true" json:"status"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"true" json:"ruleName"`
// Transition time associated with the alarm state entry. Format defined by RFC3339.
// Example: `2022-02-01T01:02:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m AlarmDimensionStatesEntry) String() string
func (m AlarmDimensionStatesEntry) ValidateEnumValue() (bool, error)
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
AlarmDimensionStatesEntryStatusEnum Enum with underlying type: string
type AlarmDimensionStatesEntryStatusEnum string
Set of constants representing the allowable values for AlarmDimensionStatesEntryStatusEnum
const (
AlarmDimensionStatesEntryStatusFiring AlarmDimensionStatesEntryStatusEnum = "FIRING"
AlarmDimensionStatesEntryStatusOk AlarmDimensionStatesEntryStatusEnum = "OK"
)
func GetAlarmDimensionStatesEntryStatusEnumValues() []AlarmDimensionStatesEntryStatusEnum
GetAlarmDimensionStatesEntryStatusEnumValues Enumerates the set of values for AlarmDimensionStatesEntryStatusEnum
func GetMappingAlarmDimensionStatesEntryStatusEnum(val string) (AlarmDimensionStatesEntryStatusEnum, bool)
GetMappingAlarmDimensionStatesEntryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmHistoryCollection The configuration details for retrieving alarm history.
type AlarmHistoryCollection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm to retrieve history for.
AlarmId *string `mandatory:"true" json:"alarmId"`
// Whether the alarm is enabled.
// Example: `true`
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The set of history entries retrieved for the alarm.
Entries []AlarmHistoryEntry `mandatory:"true" json:"entries"`
}
func (m AlarmHistoryCollection) String() string
func (m AlarmHistoryCollection) ValidateEnumValue() (bool, error)
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
AlarmHistoryEntry An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.
type AlarmHistoryEntry struct {
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"true" json:"alarmSummary"`
// Description for this alarm history entry.
// Example 1 - alarm state history entry: `The alarm state is FIRING`
// Example 2 - alarm state transition history entry: `State transitioned from OK to Firing`
Summary *string `mandatory:"true" json:"summary"`
// Timestamp for this alarm history entry. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing.
// Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.
// Example: `2023-02-01T0:59:00.789Z`
TimestampTriggered *common.SDKTime `mandatory:"false" json:"timestampTriggered"`
}
func (m AlarmHistoryEntry) String() string
func (m AlarmHistoryEntry) ValidateEnumValue() (bool, error)
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
AlarmLifecycleStateEnum Enum with underlying type: string
type AlarmLifecycleStateEnum string
Set of constants representing the allowable values for AlarmLifecycleStateEnum
const (
AlarmLifecycleStateActive AlarmLifecycleStateEnum = "ACTIVE"
AlarmLifecycleStateDeleting AlarmLifecycleStateEnum = "DELETING"
AlarmLifecycleStateDeleted AlarmLifecycleStateEnum = "DELETED"
)
func GetAlarmLifecycleStateEnumValues() []AlarmLifecycleStateEnum
GetAlarmLifecycleStateEnumValues Enumerates the set of values for AlarmLifecycleStateEnum
func GetMappingAlarmLifecycleStateEnum(val string) (AlarmLifecycleStateEnum, bool)
GetMappingAlarmLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmMessageFormatEnum Enum with underlying type: string
type AlarmMessageFormatEnum string
Set of constants representing the allowable values for AlarmMessageFormatEnum
const (
AlarmMessageFormatRaw AlarmMessageFormatEnum = "RAW"
AlarmMessageFormatPrettyJson AlarmMessageFormatEnum = "PRETTY_JSON"
AlarmMessageFormatOnsOptimized AlarmMessageFormatEnum = "ONS_OPTIMIZED"
)
func GetAlarmMessageFormatEnumValues() []AlarmMessageFormatEnum
GetAlarmMessageFormatEnumValues Enumerates the set of values for AlarmMessageFormatEnum
func GetMappingAlarmMessageFormatEnum(val string) (AlarmMessageFormatEnum, bool)
GetMappingAlarmMessageFormatEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmOverride Values to use for an independent evaluation of the alarm. You can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`)
type AlarmOverride struct {
// The period of time that the condition defined in the alarm must persist before the alarm state
// changes from "OK" to "FIRING". For example, a value of 5 minutes means that the
// alarm must persist in breaching the condition for five minutes before the alarm updates its
// state to "FIRING".
// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
// Under the default value of PT1M, the first evaluation that breaches the alarm updates the
// state to "FIRING".
// The alarm updates its status to "OK" when the breaching condition has been clear for
// the most recent minute.
// Example: `PT5M`
PendingDuration *string `mandatory:"false" json:"pendingDuration"`
// The perceived severity of the alarm with regard to the affected system.
// Example: `CRITICAL`
Severity AlarmSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// The human-readable content of the delivered alarm notification.
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// Oracle recommends providing guidance
// to operators for resolving the alarm condition. Consider adding links to standard runbook
// practices. Avoid entering confidential information.
// Example: `High CPU usage alert. Follow runbook instructions for resolution.`
Body *string `mandatory:"false" json:"body"`
// A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm.
RuleName *string `mandatory:"false" json:"ruleName"`
// 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 depend on the specified time range. More
// interval values are supported for smaller time ranges. You can optionally
// specify dimensions and grouping functions.
// Also, you can customize the
// absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm).
// Supported grouping functions: `grouping()`, `groupBy()`.
// For information about writing MQL expressions, see
// Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm).
// For details about MQL, see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.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()
// -----
// Example of absence alarm with custom absence detection period of 20 hours:
// -----
//
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)
//
// -----
Query *string `mandatory:"false" json:"query"`
}
func (m AlarmOverride) String() string
func (m AlarmOverride) ValidateEnumValue() (bool, error)
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
AlarmSeverityEnum Enum with underlying type: string
type AlarmSeverityEnum string
Set of constants representing the allowable values for AlarmSeverityEnum
const (
AlarmSeverityCritical AlarmSeverityEnum = "CRITICAL"
AlarmSeverityError AlarmSeverityEnum = "ERROR"
AlarmSeverityWarning AlarmSeverityEnum = "WARNING"
AlarmSeverityInfo AlarmSeverityEnum = "INFO"
)
func GetAlarmSeverityEnumValues() []AlarmSeverityEnum
GetAlarmSeverityEnumValues Enumerates the set of values for AlarmSeverityEnum
func GetMappingAlarmSeverityEnum(val string) (AlarmSeverityEnum, bool)
GetMappingAlarmSeverityEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmStatusSummary A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview (https://docs.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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see About the API (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see SDKS and Other Tools (https://docs.oracle.com/iaas/Content/API/Concepts/sdks.htm).
type AlarmStatusSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
Id *string `mandatory:"true" json:"id"`
// The configured name of the alarm.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"true" json:"displayName"`
// The perceived type of response required when the alarm is in the "FIRING" state.
// Example: `CRITICAL`
Severity AlarmStatusSummarySeverityEnum `mandatory:"true" json:"severity"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"true" json:"ruleName"`
// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing.
// Note: A three-minute lag for this value accounts for any late-arriving metrics.
// Example: `2023-02-01T01:02:29.600Z`
TimestampTriggered *common.SDKTime `mandatory:"true" json:"timestampTriggered"`
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"true" json:"alarmSummary"`
// The status of this alarm.
// Status is collective, across all metric streams in the alarm.
// To list alarm status for each metric stream, use RetrieveDimensionStates.
// Example: `FIRING`
Status AlarmStatusSummaryStatusEnum `mandatory:"true" json:"status"`
// The configuration details for suppressing an alarm.
Suppression *Suppression `mandatory:"false" json:"suppression"`
}
func (m AlarmStatusSummary) String() string
func (m AlarmStatusSummary) ValidateEnumValue() (bool, error)
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
AlarmStatusSummarySeverityEnum Enum with underlying type: string
type AlarmStatusSummarySeverityEnum string
Set of constants representing the allowable values for AlarmStatusSummarySeverityEnum
const (
AlarmStatusSummarySeverityCritical AlarmStatusSummarySeverityEnum = "CRITICAL"
AlarmStatusSummarySeverityError AlarmStatusSummarySeverityEnum = "ERROR"
AlarmStatusSummarySeverityWarning AlarmStatusSummarySeverityEnum = "WARNING"
AlarmStatusSummarySeverityInfo AlarmStatusSummarySeverityEnum = "INFO"
)
func GetAlarmStatusSummarySeverityEnumValues() []AlarmStatusSummarySeverityEnum
GetAlarmStatusSummarySeverityEnumValues Enumerates the set of values for AlarmStatusSummarySeverityEnum
func GetMappingAlarmStatusSummarySeverityEnum(val string) (AlarmStatusSummarySeverityEnum, bool)
GetMappingAlarmStatusSummarySeverityEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmStatusSummaryStatusEnum Enum with underlying type: string
type AlarmStatusSummaryStatusEnum string
Set of constants representing the allowable values for AlarmStatusSummaryStatusEnum
const (
AlarmStatusSummaryStatusFiring AlarmStatusSummaryStatusEnum = "FIRING"
AlarmStatusSummaryStatusOk AlarmStatusSummaryStatusEnum = "OK"
AlarmStatusSummaryStatusSuspended AlarmStatusSummaryStatusEnum = "SUSPENDED"
)
func GetAlarmStatusSummaryStatusEnumValues() []AlarmStatusSummaryStatusEnum
GetAlarmStatusSummaryStatusEnumValues Enumerates the set of values for AlarmStatusSummaryStatusEnum
func GetMappingAlarmStatusSummaryStatusEnum(val string) (AlarmStatusSummaryStatusEnum, bool)
GetMappingAlarmStatusSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmSummary A summary of properties for the specified alarm. For information about alarms, see Alarms Overview (https://docs.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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about endpoints and signing API requests, see About the API (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see SDKS and Other Tools (https://docs.oracle.com/iaas/Content/API/Concepts/sdks.htm).
type AlarmSummary struct {
// The OCID (https://docs.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.
// This value determines the title of each alarm notification.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.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 depend on the specified time range. More
// interval values are supported for smaller time ranges. Supported grouping functions: `grouping()`, `groupBy()`.
// For information about writing MQL expressions, see
// Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm).
// For details about MQL, see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.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 type of response required when the alarm is in the "FIRING" state.
// Example: `CRITICAL`
Severity AlarmSummarySeverityEnum `mandatory:"true" json:"severity"`
// A list of destinations for alarm notifications.
// Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
// of a related resource, such as a NotificationTopic.
// Supported destination services: Notifications, Streaming.
// 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"`
// Whether the alarm sends a separate message for each metric stream.
// See Creating an Alarm That Splits Messages by Metric Stream (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm-split.htm).
// Example: `true`
IsNotificationsPerMetricDimensionEnabled *bool `mandatory:"false" json:"isNotificationsPerMetricDimensionEnabled"`
// 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"`
// A set of overrides that control evaluations of the alarm.
// Each override can specify values for query, severity, body, and pending duration.
// When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
// and then evaluates the alarm's base values (`ruleName` value of `BASE`).
Overrides []AlarmOverride `mandatory:"false" json:"overrides"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"false" json:"ruleName"`
// The version of the alarm notification to be delivered. Allowed value: `1.X`
// The value must start with a number (up to four digits), followed by a period and an uppercase X.
NotificationVersion *string `mandatory:"false" json:"notificationVersion"`
// Customizable notification title (`title` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
NotificationTitle *string `mandatory:"false" json:"notificationTitle"`
// Customizable slack period to wait for metric ingestion before evaluating the alarm.
// Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M.
// For more information about the slack period, see
// About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
EvaluationSlackDuration *string `mandatory:"false" json:"evaluationSlackDuration"`
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"false" json:"alarmSummary"`
// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
}
func (m AlarmSummary) String() string
func (m AlarmSummary) ValidateEnumValue() (bool, error)
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
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"
)
func GetAlarmSummarySeverityEnumValues() []AlarmSummarySeverityEnum
GetAlarmSummarySeverityEnumValues Enumerates the set of values for AlarmSummarySeverityEnum
func GetMappingAlarmSummarySeverityEnum(val string) (AlarmSummarySeverityEnum, bool)
GetMappingAlarmSummarySeverityEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmSuppression The configuration details for an alarm suppression.
type AlarmSuppression struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
AlarmSuppressionTarget AlarmSuppressionTarget `mandatory:"true" json:"alarmSuppressionTarget"`
// The level of this alarm suppression.
// `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
// `DIMENSION` indicates a suppression configured for specified dimensions.
Level AlarmSuppressionLevelEnum `mandatory:"true" json:"level"`
// A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2018-02-01T01:02:29.600Z`
TimeSuppressFrom *common.SDKTime `mandatory:"true" json:"timeSuppressFrom"`
// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2018-02-01T02:02:29.600Z`
TimeSuppressUntil *common.SDKTime `mandatory:"true" json:"timeSuppressUntil"`
// The current lifecycle state of the alarm suppression.
// Example: `DELETED`
LifecycleState AlarmSuppressionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the alarm suppression was created. Format defined by RFC3339.
// Example: `2018-02-01T01:02:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.
// Example: `2018-02-03T01:02:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Array of all preconditions for alarm suppression.
// Example: `[{
// conditionType: "RECURRENCE",
// suppressionRecurrence: "FRQ=DAILY;BYHOUR=10",
// suppressionDuration: "PT1H"
// }]`
SuppressionConditions []SuppressionCondition `mandatory:"false" json:"suppressionConditions"`
// Human-readable reason for this alarm suppression.
// It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Oracle recommends including tracking information for the event or associated work,
// such as a ticket number.
// Example: `Planned outage due to change IT-1234.`
Description *string `mandatory:"false" json:"description"`
// Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
// 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 AlarmSuppression) String() string
func (m *AlarmSuppression) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AlarmSuppression) ValidateEnumValue() (bool, error)
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
AlarmSuppressionAlarmTarget The alarm target of the alarm suppression.
type AlarmSuppressionAlarmTarget struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression.
AlarmId *string `mandatory:"true" json:"alarmId"`
}
func (m AlarmSuppressionAlarmTarget) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AlarmSuppressionAlarmTarget) String() string
func (m AlarmSuppressionAlarmTarget) ValidateEnumValue() (bool, error)
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
AlarmSuppressionCollection Collection of property summaries for alarm suppressions.
type AlarmSuppressionCollection struct {
// List of property summaries for alarm suppressions.
Items []AlarmSuppressionSummary `mandatory:"true" json:"items"`
}
func (m AlarmSuppressionCollection) String() string
func (m AlarmSuppressionCollection) ValidateEnumValue() (bool, error)
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
AlarmSuppressionCompartmentTarget The compartment target of the alarm suppression.
type AlarmSuppressionCompartmentTarget struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment or tenancy that is the
// target of the alarm suppression.
// Example: `ocid1.compartment.oc1..exampleuniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// When true, the alarm suppression targets all alarms under all compartments and subcompartments of
// the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID
// (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under
// the specified compartment.
CompartmentIdInSubtree *bool `mandatory:"false" json:"compartmentIdInSubtree"`
}
func (m AlarmSuppressionCompartmentTarget) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AlarmSuppressionCompartmentTarget) String() string
func (m AlarmSuppressionCompartmentTarget) ValidateEnumValue() (bool, error)
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
AlarmSuppressionHistoryItem A summary of properties for the specified alarm suppression history item.
type AlarmSuppressionHistoryItem struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
SuppressionId *string `mandatory:"true" json:"suppressionId"`
AlarmSuppressionTarget AlarmSuppressionTarget `mandatory:"true" json:"alarmSuppressionTarget"`
// The level of this alarm suppression.
// `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
// `DIMENSION` indicates a suppression configured for specified dimensions.
Level AlarmSuppressionHistoryItemLevelEnum `mandatory:"true" json:"level"`
// A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The start date and time for the suppression actually starts, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeEffectiveFrom *common.SDKTime `mandatory:"true" json:"timeEffectiveFrom"`
// The end date and time for the suppression actually ends, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T02:02:29.600Z`
TimeEffectiveUntil *common.SDKTime `mandatory:"true" json:"timeEffectiveUntil"`
// Human-readable reason for this alarm suppression.
// It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Oracle recommends including tracking information for the event or associated work,
// such as a ticket number.
// Example: `Planned outage due to change IT-1234.`
Description *string `mandatory:"false" json:"description"`
// Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
// Array of all preconditions for alarm suppression.
// Example: `[{
// conditionType: "RECURRENCE",
// suppressionRecurrence: "FRQ=DAILY;BYHOUR=10",
// suppressionDuration: "PT1H"
// }]`
SuppressionConditions []SuppressionCondition `mandatory:"false" json:"suppressionConditions"`
}
func (m AlarmSuppressionHistoryItem) String() string
func (m *AlarmSuppressionHistoryItem) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AlarmSuppressionHistoryItem) ValidateEnumValue() (bool, error)
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
AlarmSuppressionHistoryItemCollection Collection of property summaries for alarm suppression history items.
type AlarmSuppressionHistoryItemCollection struct {
// List of alarm suppression history items.
Items []AlarmSuppressionHistoryItem `mandatory:"true" json:"items"`
}
func (m AlarmSuppressionHistoryItemCollection) String() string
func (m AlarmSuppressionHistoryItemCollection) ValidateEnumValue() (bool, error)
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
AlarmSuppressionHistoryItemLevelEnum Enum with underlying type: string
type AlarmSuppressionHistoryItemLevelEnum string
Set of constants representing the allowable values for AlarmSuppressionHistoryItemLevelEnum
const (
AlarmSuppressionHistoryItemLevelAlarm AlarmSuppressionHistoryItemLevelEnum = "ALARM"
AlarmSuppressionHistoryItemLevelDimension AlarmSuppressionHistoryItemLevelEnum = "DIMENSION"
)
func GetAlarmSuppressionHistoryItemLevelEnumValues() []AlarmSuppressionHistoryItemLevelEnum
GetAlarmSuppressionHistoryItemLevelEnumValues Enumerates the set of values for AlarmSuppressionHistoryItemLevelEnum
func GetMappingAlarmSuppressionHistoryItemLevelEnum(val string) (AlarmSuppressionHistoryItemLevelEnum, bool)
GetMappingAlarmSuppressionHistoryItemLevelEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmSuppressionLevelEnum Enum with underlying type: string
type AlarmSuppressionLevelEnum string
Set of constants representing the allowable values for AlarmSuppressionLevelEnum
const (
AlarmSuppressionLevelAlarm AlarmSuppressionLevelEnum = "ALARM"
AlarmSuppressionLevelDimension AlarmSuppressionLevelEnum = "DIMENSION"
)
func GetAlarmSuppressionLevelEnumValues() []AlarmSuppressionLevelEnum
GetAlarmSuppressionLevelEnumValues Enumerates the set of values for AlarmSuppressionLevelEnum
func GetMappingAlarmSuppressionLevelEnum(val string) (AlarmSuppressionLevelEnum, bool)
GetMappingAlarmSuppressionLevelEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmSuppressionLifecycleStateEnum Enum with underlying type: string
type AlarmSuppressionLifecycleStateEnum string
Set of constants representing the allowable values for AlarmSuppressionLifecycleStateEnum
const (
AlarmSuppressionLifecycleStateActive AlarmSuppressionLifecycleStateEnum = "ACTIVE"
AlarmSuppressionLifecycleStateDeleted AlarmSuppressionLifecycleStateEnum = "DELETED"
)
func GetAlarmSuppressionLifecycleStateEnumValues() []AlarmSuppressionLifecycleStateEnum
GetAlarmSuppressionLifecycleStateEnumValues Enumerates the set of values for AlarmSuppressionLifecycleStateEnum
func GetMappingAlarmSuppressionLifecycleStateEnum(val string) (AlarmSuppressionLifecycleStateEnum, bool)
GetMappingAlarmSuppressionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AlarmSuppressionSummary A summary of properties for the specified alarm suppression.
type AlarmSuppressionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
AlarmSuppressionTarget AlarmSuppressionTarget `mandatory:"true" json:"alarmSuppressionTarget"`
// The level of this alarm suppression.
// `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
// `DIMENSION` indicates a suppression configured for specified dimensions.
Level AlarmSuppressionLevelEnum `mandatory:"true" json:"level"`
// A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeSuppressFrom *common.SDKTime `mandatory:"true" json:"timeSuppressFrom"`
// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T02:02:29.600Z`
TimeSuppressUntil *common.SDKTime `mandatory:"true" json:"timeSuppressUntil"`
// The current lifecycle state of the alarm suppression.
// Example: `DELETED`
LifecycleState AlarmSuppressionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the alarm suppression was created. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.
// Example: `2023-02-03T01:02:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Array of all preconditions for alarm suppression.
// Example: `[{
// conditionType: "RECURRENCE",
// suppressionRecurrence: "FRQ=DAILY;BYHOUR=10",
// suppressionDuration: "PT1H"
// }]`
SuppressionConditions []SuppressionCondition `mandatory:"false" json:"suppressionConditions"`
// Human-readable reason for this alarm suppression.
// It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Oracle recommends including tracking information for the event or associated work,
// such as a ticket number.
// Example: `Planned outage due to change IT-1234.`
Description *string `mandatory:"false" json:"description"`
// Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m AlarmSuppressionSummary) String() string
func (m *AlarmSuppressionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AlarmSuppressionSummary) ValidateEnumValue() (bool, error)
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
AlarmSuppressionTarget The target of the alarm suppression.
type AlarmSuppressionTarget interface {
}
AlarmSuppressionTargetTargetTypeEnum Enum with underlying type: string
type AlarmSuppressionTargetTargetTypeEnum string
Set of constants representing the allowable values for AlarmSuppressionTargetTargetTypeEnum
const (
AlarmSuppressionTargetTargetTypeAlarm AlarmSuppressionTargetTargetTypeEnum = "ALARM"
AlarmSuppressionTargetTargetTypeCompartment AlarmSuppressionTargetTargetTypeEnum = "COMPARTMENT"
)
func GetAlarmSuppressionTargetTargetTypeEnumValues() []AlarmSuppressionTargetTargetTypeEnum
GetAlarmSuppressionTargetTargetTypeEnumValues Enumerates the set of values for AlarmSuppressionTargetTargetTypeEnum
func GetMappingAlarmSuppressionTargetTargetTypeEnum(val string) (AlarmSuppressionTargetTargetTypeEnum, bool)
GetMappingAlarmSuppressionTargetTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeAlarmCompartmentDetails The configuration details for moving an alarm.
type ChangeAlarmCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the alarm to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeAlarmCompartmentDetails) String() string
func (m ChangeAlarmCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeAlarmCompartmentRequest wrapper for the ChangeAlarmCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ChangeAlarmCompartment.go.html to see an example of how to use ChangeAlarmCompartmentRequest.
type ChangeAlarmCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
AlarmId *string `mandatory:"true" contributesTo:"path" name:"alarmId"`
// The configuration details for moving an alarm.
ChangeAlarmCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// 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"`
// 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 ChangeAlarmCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAlarmCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAlarmCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAlarmCompartmentRequest) String() string
func (request ChangeAlarmCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeAlarmCompartmentResponse wrapper for the ChangeAlarmCompartment operation
type ChangeAlarmCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeAlarmCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAlarmCompartmentResponse) String() string
CreateAlarmDetails The configuration details for creating an alarm.
type CreateAlarmDetails struct {
// A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// This value determines the title of each alarm notification.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.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 depend on the specified time range. More
// interval values are supported for smaller time ranges. You can optionally
// specify dimensions and grouping functions.
// Also, you can customize the
// absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm).
// Supported grouping functions: `grouping()`, `groupBy()`.
// For information about writing MQL expressions, see
// Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm).
// For details about MQL, see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.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()
// -----
// Example of absence alarm with custom absence detection period of 20 hours:
// -----
//
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)
//
// -----
Query *string `mandatory:"true" json:"query"`
// The perceived type of response required when the alarm is in the "FIRING" state.
// Example: `CRITICAL`
Severity AlarmSeverityEnum `mandatory:"true" json:"severity"`
// A list of destinations for alarm notifications.
// Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
// of a related resource, such as a NotificationTopic.
// Supported destination services: Notifications, Streaming.
// 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"`
// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can
// only be set to true when metricCompartmentId 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, the alarm evaluates metrics from only the compartment specified
// in metricCompartmentId. Default is false.
// Example: `true`
MetricCompartmentIdInSubtree *bool `mandatory:"false" json:"metricCompartmentIdInSubtree"`
// Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Avoid entering confidential information.
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The time between calculated aggregation windows for the alarm. Supported value: `1m`
Resolution *string `mandatory:"false" json:"resolution"`
// The period of time that the condition defined in the alarm must persist before the alarm state
// changes from "OK" to "FIRING". For example, a value of 5 minutes means that the
// alarm must persist in breaching the condition for five minutes before the alarm updates its
// state to "FIRING".
// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
// Under the default value of PT1M, the first evaluation that breaches the alarm updates the
// state to "FIRING".
// The alarm updates its status to "OK" when the breaching condition has been clear for
// the most recent minute.
// Example: `PT5M`
PendingDuration *string `mandatory:"false" json:"pendingDuration"`
// The human-readable content of the delivered alarm notification.
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// Oracle recommends providing guidance
// to operators for resolving the alarm condition. Consider adding links to standard runbook
// practices. Avoid entering confidential information.
// Example: `High CPU usage alert. Follow runbook instructions for resolution.`
Body *string `mandatory:"false" json:"body"`
// When set to `true`, splits alarm notifications per metric stream.
// When set to `false`, groups alarm notifications across metric streams.
// Example: `true`
IsNotificationsPerMetricDimensionEnabled *bool `mandatory:"false" json:"isNotificationsPerMetricDimensionEnabled"`
// The format to use for alarm notifications. The formats are:
// * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format.
// * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only.
// * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only.
MessageFormat CreateAlarmDetailsMessageFormatEnum `mandatory:"false" json:"messageFormat,omitempty"`
// The frequency for re-submitting alarm notifications, if the alarm keeps firing without
// interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours.
// Minimum: PT1M. Maximum: P30D.
// Default value: null (notifications are not re-submitted).
// Example: `PT2H`
RepeatNotificationDuration *string `mandatory:"false" json:"repeatNotificationDuration"`
// 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"`
// A set of overrides that control evaluations of the alarm.
// Each override can specify values for query, severity, body, and pending duration.
// When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
// and then evaluates the alarm's base values (`ruleName` value of `BASE`).
Overrides []AlarmOverride `mandatory:"false" json:"overrides"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"false" json:"ruleName"`
// The version of the alarm notification to be delivered. Allowed value: `1.X`
// The value must start with a number (up to four digits), followed by a period and an uppercase X.
NotificationVersion *string `mandatory:"false" json:"notificationVersion"`
// Customizable notification title (`title` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
NotificationTitle *string `mandatory:"false" json:"notificationTitle"`
// Customizable slack period to wait for metric ingestion before evaluating the alarm.
// Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M.
// For more information about the slack period, see
// About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
EvaluationSlackDuration *string `mandatory:"false" json:"evaluationSlackDuration"`
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"false" json:"alarmSummary"`
}
func (m CreateAlarmDetails) String() string
func (m CreateAlarmDetails) ValidateEnumValue() (bool, error)
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
CreateAlarmDetailsMessageFormatEnum Enum with underlying type: string
type CreateAlarmDetailsMessageFormatEnum string
Set of constants representing the allowable values for CreateAlarmDetailsMessageFormatEnum
const (
CreateAlarmDetailsMessageFormatRaw CreateAlarmDetailsMessageFormatEnum = "RAW"
CreateAlarmDetailsMessageFormatPrettyJson CreateAlarmDetailsMessageFormatEnum = "PRETTY_JSON"
CreateAlarmDetailsMessageFormatOnsOptimized CreateAlarmDetailsMessageFormatEnum = "ONS_OPTIMIZED"
)
func GetCreateAlarmDetailsMessageFormatEnumValues() []CreateAlarmDetailsMessageFormatEnum
GetCreateAlarmDetailsMessageFormatEnumValues Enumerates the set of values for CreateAlarmDetailsMessageFormatEnum
func GetMappingCreateAlarmDetailsMessageFormatEnum(val string) (CreateAlarmDetailsMessageFormatEnum, bool)
GetMappingCreateAlarmDetailsMessageFormatEnum performs case Insensitive comparison on enum value and return the desired enum
CreateAlarmRequest wrapper for the CreateAlarm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/CreateAlarm.go.html to see an example of how to use CreateAlarmRequest.
type CreateAlarmRequest struct {
// Document for creating an alarm.
CreateAlarmDetails `contributesTo:"body"`
// 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"`
// 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"`
// 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 CreateAlarmRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAlarmRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAlarmRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAlarmRequest) String() string
func (request CreateAlarmRequest) ValidateEnumValue() (bool, error)
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
CreateAlarmResponse wrapper for the CreateAlarm operation
type CreateAlarmResponse struct {
// The underlying http response
RawResponse *http.Response
// The Alarm instance
Alarm `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 CreateAlarmResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAlarmResponse) String() string
CreateAlarmSuppressionDetails The configuration details for creating an alarm suppression.
type CreateAlarmSuppressionDetails struct {
AlarmSuppressionTarget AlarmSuppressionTarget `mandatory:"true" json:"alarmSuppressionTarget"`
// A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeSuppressFrom *common.SDKTime `mandatory:"true" json:"timeSuppressFrom"`
// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T02:02:29.600Z`
TimeSuppressUntil *common.SDKTime `mandatory:"true" json:"timeSuppressUntil"`
// The level of this alarm suppression.
// `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
// `DIMENSION` indicates a suppression configured for specified dimensions.
// Defaut: `DIMENSION`
Level AlarmSuppressionLevelEnum `mandatory:"false" json:"level,omitempty"`
// Human-readable reason for this alarm suppression.
// It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Oracle recommends including tracking information for the event or associated work,
// such as a ticket number.
// Example: `Planned outage due to change IT-1234.`
Description *string `mandatory:"false" json:"description"`
// A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs.
// If you specify {"availabilityDomain": "phx-ad-1"}
// and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"},
// then this alarm will be included for suppression.
// This is required only when the value of level is `DIMENSION`. If required, the value cannot be an empty object.
// Only a single value is allowed per key. No grouping of multiple values is allowed under the same key.
// Maximum characters (after serialization): 4000. This maximum satisfies typical use cases.
// The response for an exceeded maximum is `HTTP 400` with an "dimensions values are too long" message.
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
// 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"`
// Array of all preconditions for alarm suppression.
// Example: `[{
// conditionType: "RECURRENCE",
// suppressionRecurrence: "FRQ=DAILY;BYHOUR=10",
// suppressionDuration: "PT1H"
// }]`
SuppressionConditions []SuppressionCondition `mandatory:"false" json:"suppressionConditions"`
}
func (m CreateAlarmSuppressionDetails) String() string
func (m *CreateAlarmSuppressionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateAlarmSuppressionDetails) ValidateEnumValue() (bool, error)
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
CreateAlarmSuppressionRequest wrapper for the CreateAlarmSuppression operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/CreateAlarmSuppression.go.html to see an example of how to use CreateAlarmSuppressionRequest.
type CreateAlarmSuppressionRequest struct {
// The details of the alarm suppression to be created
CreateAlarmSuppressionDetails `contributesTo:"body"`
// 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"`
// 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"`
// 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 CreateAlarmSuppressionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAlarmSuppressionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAlarmSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAlarmSuppressionRequest) String() string
func (request CreateAlarmSuppressionRequest) ValidateEnumValue() (bool, error)
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
CreateAlarmSuppressionResponse wrapper for the CreateAlarmSuppression operation
type CreateAlarmSuppressionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AlarmSuppression instance
AlarmSuppression `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateAlarmSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAlarmSuppressionResponse) String() string
Datapoint Metric value for a specific timestamp.
type Datapoint struct {
// Timestamp for this metric value. Format defined by RFC3339.
// For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).
// Example: `2023-02-01T01:02:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Numeric value of the metric.
// Example: `10.23`
Value *float64 `mandatory:"true" json:"value"`
// The number of occurrences of the associated value in the set of data.
// Default is 1. Value must be greater than zero.
Count *int `mandatory:"false" json:"count"`
}
func (m Datapoint) String() string
func (m Datapoint) ValidateEnumValue() (bool, error)
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
DeleteAlarmRequest wrapper for the DeleteAlarm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/DeleteAlarm.go.html to see an example of how to use DeleteAlarmRequest.
type DeleteAlarmRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
AlarmId *string `mandatory:"true" contributesTo:"path" name:"alarmId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// 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 DeleteAlarmRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAlarmRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAlarmRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAlarmRequest) String() string
func (request DeleteAlarmRequest) ValidateEnumValue() (bool, error)
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
DeleteAlarmResponse wrapper for the DeleteAlarm operation
type DeleteAlarmResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteAlarmResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAlarmResponse) String() string
DeleteAlarmSuppressionRequest wrapper for the DeleteAlarmSuppression operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/DeleteAlarmSuppression.go.html to see an example of how to use DeleteAlarmSuppressionRequest.
type DeleteAlarmSuppressionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
AlarmSuppressionId *string `mandatory:"true" contributesTo:"path" name:"alarmSuppressionId"`
// 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 optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteAlarmSuppressionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAlarmSuppressionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAlarmSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAlarmSuppressionRequest) String() string
func (request DeleteAlarmSuppressionRequest) ValidateEnumValue() (bool, error)
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
DeleteAlarmSuppressionResponse wrapper for the DeleteAlarmSuppression operation
type DeleteAlarmSuppressionResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteAlarmSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAlarmSuppressionResponse) String() string
FailedMetricRecord The record of a single metric object that failed input validation and the reason for the failure.
type FailedMetricRecord struct {
// An error message indicating the reason that the indicated metric object failed input validation.
Message *string `mandatory:"true" json:"message"`
// Identifier of a metric object that failed input validation.
MetricData *MetricDataDetails `mandatory:"true" json:"metricData"`
}
func (m FailedMetricRecord) String() string
func (m FailedMetricRecord) ValidateEnumValue() (bool, error)
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
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"
)
func GetGetAlarmHistoryAlarmHistorytypeEnumValues() []GetAlarmHistoryAlarmHistorytypeEnum
GetGetAlarmHistoryAlarmHistorytypeEnumValues Enumerates the set of values for GetAlarmHistoryAlarmHistorytypeEnum
func GetMappingGetAlarmHistoryAlarmHistorytypeEnum(val string) (GetAlarmHistoryAlarmHistorytypeEnum, bool)
GetMappingGetAlarmHistoryAlarmHistorytypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetAlarmHistoryRequest wrapper for the GetAlarmHistory operation
Click https://docs.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.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.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.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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAlarmHistoryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAlarmHistoryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAlarmHistoryRequest) String() string
func (request GetAlarmHistoryRequest) ValidateEnumValue() (bool, error)
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
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response GetAlarmHistoryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAlarmHistoryResponse) String() string
GetAlarmRequest wrapper for the GetAlarm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarm.go.html to see an example of how to use GetAlarmRequest.
type GetAlarmRequest struct {
// The OCID (https://docs.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"`
// 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 GetAlarmRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAlarmRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAlarmRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAlarmRequest) String() string
func (request GetAlarmRequest) ValidateEnumValue() (bool, error)
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
GetAlarmResponse wrapper for the GetAlarm operation
type GetAlarmResponse struct {
// The underlying http response
RawResponse *http.Response
// The Alarm instance
Alarm `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetAlarmResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAlarmResponse) String() string
GetAlarmSuppressionRequest wrapper for the GetAlarmSuppression operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarmSuppression.go.html to see an example of how to use GetAlarmSuppressionRequest.
type GetAlarmSuppressionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression.
AlarmSuppressionId *string `mandatory:"true" contributesTo:"path" name:"alarmSuppressionId"`
// 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"`
// 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 GetAlarmSuppressionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAlarmSuppressionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAlarmSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAlarmSuppressionRequest) String() string
func (request GetAlarmSuppressionRequest) ValidateEnumValue() (bool, error)
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
GetAlarmSuppressionResponse wrapper for the GetAlarmSuppression operation
type GetAlarmSuppressionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AlarmSuppression instance
AlarmSuppression `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetAlarmSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAlarmSuppressionResponse) String() string
ListAlarmSuppressionsRequest wrapper for the ListAlarmSuppressions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarmSuppressions.go.html to see an example of how to use ListAlarmSuppressionsRequest.
type ListAlarmSuppressionsRequest struct {
// 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 OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression.
AlarmId *string `mandatory:"false" contributesTo:"query" name:"alarmId"`
// A filter to return only resources that match the given display name exactly.
// Use this filter to list an alarm suppression by name.
// Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
LifecycleState AlarmSuppressionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The level of this alarm suppression.
// `ALARM` indicates a suppression of the entire alarm, regardless of dimension.
// `DIMENSION` indicates a suppression configured for specified dimensions.
Level AlarmSuppressionLevelEnum `mandatory:"false" contributesTo:"query" name:"level" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching.
// Use the tenancy OCID to search in the root compartment.
// If targetType is not specified, searches all suppressions defined under the compartment.
// If targetType is `COMPARTMENT`, searches suppressions in the specified compartment only.
// Example: `ocid1.compartment.oc1..exampleuniqueID`
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// 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"`
// The target type to use when listing alarm suppressions.
// `ALARM` lists all suppression records for the specified alarm.
// `COMPARTMENT` lists all suppression records for the specified compartment or tenancy.
TargetType ListAlarmSuppressionsTargetTypeEnum `mandatory:"false" contributesTo:"query" name:"targetType" omitEmpty:"true"`
// Setting this parameter to true requires the query to specify the alarm (`alarmId`).
// When true, lists all alarm suppressions that affect the specified alarm,
// including suppressions that target the corresponding compartment or tenancy.
// When false, lists only the alarm suppressions that target the specified alarm.
// Default is false.
IsAllSuppressions *bool `mandatory:"false" contributesTo:"query" name:"isAllSuppressions"`
// The field to use when sorting returned alarm suppressions. Only one sorting level is provided.
// Example: `timeCreated`
SortBy ListAlarmSuppressionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC).
// Example: `ASC`
SortOrder ListAlarmSuppressionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Default: 1000
// Example: 500
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListAlarmSuppressionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAlarmSuppressionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAlarmSuppressionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAlarmSuppressionsRequest) String() string
func (request ListAlarmSuppressionsRequest) ValidateEnumValue() (bool, error)
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
ListAlarmSuppressionsResponse wrapper for the ListAlarmSuppressions operation
type ListAlarmSuppressionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AlarmSuppressionCollection instances
AlarmSuppressionCollection `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, next page of results remains.
// For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results remains.
// For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response ListAlarmSuppressionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAlarmSuppressionsResponse) String() string
ListAlarmSuppressionsSortByEnum Enum with underlying type: string
type ListAlarmSuppressionsSortByEnum string
Set of constants representing the allowable values for ListAlarmSuppressionsSortByEnum
const (
ListAlarmSuppressionsSortByDisplayname ListAlarmSuppressionsSortByEnum = "displayName"
ListAlarmSuppressionsSortByTimecreated ListAlarmSuppressionsSortByEnum = "timeCreated"
ListAlarmSuppressionsSortByTimesuppressfrom ListAlarmSuppressionsSortByEnum = "timeSuppressFrom"
)
func GetListAlarmSuppressionsSortByEnumValues() []ListAlarmSuppressionsSortByEnum
GetListAlarmSuppressionsSortByEnumValues Enumerates the set of values for ListAlarmSuppressionsSortByEnum
func GetMappingListAlarmSuppressionsSortByEnum(val string) (ListAlarmSuppressionsSortByEnum, bool)
GetMappingListAlarmSuppressionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmSuppressionsSortOrderEnum Enum with underlying type: string
type ListAlarmSuppressionsSortOrderEnum string
Set of constants representing the allowable values for ListAlarmSuppressionsSortOrderEnum
const (
ListAlarmSuppressionsSortOrderAsc ListAlarmSuppressionsSortOrderEnum = "ASC"
ListAlarmSuppressionsSortOrderDesc ListAlarmSuppressionsSortOrderEnum = "DESC"
)
func GetListAlarmSuppressionsSortOrderEnumValues() []ListAlarmSuppressionsSortOrderEnum
GetListAlarmSuppressionsSortOrderEnumValues Enumerates the set of values for ListAlarmSuppressionsSortOrderEnum
func GetMappingListAlarmSuppressionsSortOrderEnum(val string) (ListAlarmSuppressionsSortOrderEnum, bool)
GetMappingListAlarmSuppressionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmSuppressionsTargetTypeEnum Enum with underlying type: string
type ListAlarmSuppressionsTargetTypeEnum string
Set of constants representing the allowable values for ListAlarmSuppressionsTargetTypeEnum
const (
ListAlarmSuppressionsTargetTypeAlarm ListAlarmSuppressionsTargetTypeEnum = "ALARM"
ListAlarmSuppressionsTargetTypeCompartment ListAlarmSuppressionsTargetTypeEnum = "COMPARTMENT"
)
func GetListAlarmSuppressionsTargetTypeEnumValues() []ListAlarmSuppressionsTargetTypeEnum
GetListAlarmSuppressionsTargetTypeEnumValues Enumerates the set of values for ListAlarmSuppressionsTargetTypeEnum
func GetMappingListAlarmSuppressionsTargetTypeEnum(val string) (ListAlarmSuppressionsTargetTypeEnum, bool)
GetMappingListAlarmSuppressionsTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmsRequest wrapper for the ListAlarms operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarms.go.html to see an example of how to use ListAlarmsRequest.
type ListAlarmsRequest struct {
// The OCID (https://docs.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.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.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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAlarmsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAlarmsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAlarmsRequest) String() string
func (request ListAlarmsRequest) ValidateEnumValue() (bool, error)
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
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.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) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAlarmsResponse) String() string
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"
)
func GetListAlarmsSortByEnumValues() []ListAlarmsSortByEnum
GetListAlarmsSortByEnumValues Enumerates the set of values for ListAlarmsSortByEnum
func GetMappingListAlarmsSortByEnum(val string) (ListAlarmsSortByEnum, bool)
GetMappingListAlarmsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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"
)
func GetListAlarmsSortOrderEnumValues() []ListAlarmsSortOrderEnum
GetListAlarmsSortOrderEnumValues Enumerates the set of values for ListAlarmsSortOrderEnum
func GetMappingListAlarmsSortOrderEnum(val string) (ListAlarmsSortOrderEnum, bool)
GetMappingListAlarmsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmsStatusRequest wrapper for the ListAlarmsStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarmsStatus.go.html to see an example of how to use ListAlarmsStatusRequest.
type ListAlarmsStatusRequest struct {
// The OCID (https://docs.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"`
// 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"`
// 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.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.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"`
// The field to use when sorting returned alarm definitions. Only one sorting level is provided.
// Example: `severity`
SortBy ListAlarmsStatusSortByEnum `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 ListAlarmsStatusSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A filter to return only the resource with the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
// The resource must be monitored by the metric that you are searching for.
// Example: `ocid1.instance.oc1.phx.exampleuniqueID`
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// A filter to return only resources that match the given service name exactly.
// Use this filter to list all alarms containing metric streams that match the *exact* service-name dimension.
// Example: `logging-analytics`
ServiceName *string `mandatory:"false" contributesTo:"query" name:"serviceName"`
// A filter to return only resources that match the given entity OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) exactly.
// The resource (entity) must be monitored by the metric that you are searching for.
// Example: `ocid1.instance.oc1.phx.exampleuniqueID`
EntityId *string `mandatory:"false" contributesTo:"query" name:"entityId"`
// A filter to return only metric streams that match the specified status.
// For example, the value "FIRING" returns only firing metric streams.
// Example: `FIRING`
Status ListAlarmsStatusStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// 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 ListAlarmsStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAlarmsStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAlarmsStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAlarmsStatusRequest) String() string
func (request ListAlarmsStatusRequest) ValidateEnumValue() (bool, error)
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
ListAlarmsStatusResponse wrapper for the ListAlarmsStatus operation
type ListAlarmsStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AlarmStatusSummary instances
Items []AlarmStatusSummary `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.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 ListAlarmsStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAlarmsStatusResponse) String() string
ListAlarmsStatusSortByEnum Enum with underlying type: string
type ListAlarmsStatusSortByEnum string
Set of constants representing the allowable values for ListAlarmsStatusSortByEnum
const (
ListAlarmsStatusSortByDisplayname ListAlarmsStatusSortByEnum = "displayName"
ListAlarmsStatusSortBySeverity ListAlarmsStatusSortByEnum = "severity"
)
func GetListAlarmsStatusSortByEnumValues() []ListAlarmsStatusSortByEnum
GetListAlarmsStatusSortByEnumValues Enumerates the set of values for ListAlarmsStatusSortByEnum
func GetMappingListAlarmsStatusSortByEnum(val string) (ListAlarmsStatusSortByEnum, bool)
GetMappingListAlarmsStatusSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmsStatusSortOrderEnum Enum with underlying type: string
type ListAlarmsStatusSortOrderEnum string
Set of constants representing the allowable values for ListAlarmsStatusSortOrderEnum
const (
ListAlarmsStatusSortOrderAsc ListAlarmsStatusSortOrderEnum = "ASC"
ListAlarmsStatusSortOrderDesc ListAlarmsStatusSortOrderEnum = "DESC"
)
func GetListAlarmsStatusSortOrderEnumValues() []ListAlarmsStatusSortOrderEnum
GetListAlarmsStatusSortOrderEnumValues Enumerates the set of values for ListAlarmsStatusSortOrderEnum
func GetMappingListAlarmsStatusSortOrderEnum(val string) (ListAlarmsStatusSortOrderEnum, bool)
GetMappingListAlarmsStatusSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAlarmsStatusStatusEnum Enum with underlying type: string
type ListAlarmsStatusStatusEnum string
Set of constants representing the allowable values for ListAlarmsStatusStatusEnum
const (
ListAlarmsStatusStatusFiring ListAlarmsStatusStatusEnum = "FIRING"
ListAlarmsStatusStatusOk ListAlarmsStatusStatusEnum = "OK"
)
func GetListAlarmsStatusStatusEnumValues() []ListAlarmsStatusStatusEnum
GetListAlarmsStatusStatusEnumValues Enumerates the set of values for ListAlarmsStatusStatusEnum
func GetMappingListAlarmsStatusStatusEnum(val string) (ListAlarmsStatusStatusEnum, bool)
GetMappingListAlarmsStatusStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetricsDetails The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk (*) as a wildcard character, placed anywhere in the string. For example, to search for all metrics with names that begin with "disk", specify "name" as "disk*". If no properties are specified, then all metric definitions within the request scope are returned.
type ListMetricsDetails struct {
// The metric name to use when searching for metric definitions.
// Example: `CpuUtilization`
Name *string `mandatory:"false" json:"name"`
// The source service or application to use when searching for metric definitions.
// Example: `oci_computeagent`
Namespace *string `mandatory:"false" json:"namespace"`
// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// Qualifiers that you want to use when searching for metric definitions.
// Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
DimensionFilters map[string]string `mandatory:"false" json:"dimensionFilters"`
// Group metrics by these fields in the response. For example, to list all metric namespaces available
// in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.
// If `groupBy` is used, then `dimensionFilters` is ignored.
// Example - group by namespace:
// `[ "namespace" ]`
GroupBy []string `mandatory:"false" json:"groupBy"`
// The field to use when sorting returned metric definitions. Only one sorting level is provided.
// Example: `NAMESPACE`
SortBy ListMetricsDetailsSortByEnum `mandatory:"false" json:"sortBy,omitempty"`
// The sort order to use when sorting returned metric definitions. Ascending (ASC) or
// descending (DESC).
// Example: `ASC`
SortOrder ListMetricsDetailsSortOrderEnum `mandatory:"false" json:"sortOrder,omitempty"`
}
func (m ListMetricsDetails) String() string
func (m ListMetricsDetails) ValidateEnumValue() (bool, error)
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
ListMetricsDetailsSortByEnum Enum with underlying type: string
type ListMetricsDetailsSortByEnum string
Set of constants representing the allowable values for ListMetricsDetailsSortByEnum
const (
ListMetricsDetailsSortByNamespace ListMetricsDetailsSortByEnum = "NAMESPACE"
ListMetricsDetailsSortByName ListMetricsDetailsSortByEnum = "NAME"
ListMetricsDetailsSortByResourcegroup ListMetricsDetailsSortByEnum = "RESOURCEGROUP"
)
func GetListMetricsDetailsSortByEnumValues() []ListMetricsDetailsSortByEnum
GetListMetricsDetailsSortByEnumValues Enumerates the set of values for ListMetricsDetailsSortByEnum
func GetMappingListMetricsDetailsSortByEnum(val string) (ListMetricsDetailsSortByEnum, bool)
GetMappingListMetricsDetailsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetricsDetailsSortOrderEnum Enum with underlying type: string
type ListMetricsDetailsSortOrderEnum string
Set of constants representing the allowable values for ListMetricsDetailsSortOrderEnum
const (
ListMetricsDetailsSortOrderAsc ListMetricsDetailsSortOrderEnum = "ASC"
ListMetricsDetailsSortOrderDesc ListMetricsDetailsSortOrderEnum = "DESC"
)
func GetListMetricsDetailsSortOrderEnumValues() []ListMetricsDetailsSortOrderEnum
GetListMetricsDetailsSortOrderEnumValues Enumerates the set of values for ListMetricsDetailsSortOrderEnum
func GetMappingListMetricsDetailsSortOrderEnum(val string) (ListMetricsDetailsSortOrderEnum, bool)
GetMappingListMetricsDetailsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListMetricsRequest wrapper for the ListMetrics operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListMetrics.go.html to see an example of how to use ListMetricsRequest.
type ListMetricsRequest struct {
// The OCID (https://docs.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"`
// The dimensions used to filter metrics.
ListMetricsDetails `contributesTo:"body"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Default: 1000
// Example: 500
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListMetricsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMetricsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMetricsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMetricsRequest) String() string
func (request ListMetricsRequest) ValidateEnumValue() (bool, error)
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
ListMetricsResponse wrapper for the ListMetrics operation
type ListMetricsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []Metric instances
Items []Metric `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.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 ListMetricsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMetricsResponse) String() string
Metric The properties that define a metric. For information about metrics, see Metrics Overview (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).
type Metric struct {
// The name of the metric.
// Example: `CpuUtilization`
Name *string `mandatory:"false" json:"name"`
// The source service or application emitting the metric.
// Example: `oci_computeagent`
Namespace *string `mandatory:"false" json:"namespace"`
// Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing
// the resources monitored by the metric.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.
// Each dimension takes the form of a key-value pair.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
}
func (m Metric) String() string
func (m Metric) ValidateEnumValue() (bool, error)
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
MetricData The set of aggregated data returned for a metric. For information about metrics, see Metrics Overview (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). Limits information for returned data follows. * Data points: 100,000. * Metric streams* within data points: 2,000. * Time range returned for 1-day resolution: 90 days. * Time range returned for 1-hour resolution: 90 days. * Time range returned for 5-minute resolution: 30 days. * Time range returned for 1-minute resolution: 7 days. *A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see Monitoring Concepts (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
type MetricData struct {
// The reference provided in a metric definition to indicate the source service or
// application that emitted the metric.
// Example: `oci_computeagent`
Namespace *string `mandatory:"true" json:"namespace"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the
// resources that the aggregated data was returned from.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the metric.
// Example: `CpuUtilization`
Name *string `mandatory:"true" json:"name"`
// Qualifiers provided in the definition of the returned metric.
// Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"true" json:"dimensions"`
// The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request.
// For important limits information related to data points, see MetricData Reference at the top of this page.
AggregatedDatapoints []AggregatedDatapoint `mandatory:"true" json:"aggregatedDatapoints"`
// Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The references provided in a metric definition to indicate extra information about the metric.
// Example: `"unit": "bytes"`
Metadata map[string]string `mandatory:"false" json:"metadata"`
// The time between calculated aggregation windows. Use with the query interval to vary the
// frequency for returning aggregated data points. For example, use a query interval of
// 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute
// frequency. The resolution must be equal or less than the interval in the query. The default
// resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.
// Example: `5m`
Resolution *string `mandatory:"false" json:"resolution"`
}
func (m MetricData) String() string
func (m MetricData) ValidateEnumValue() (bool, error)
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
MetricDataDetails A metric object containing raw metric data points to be posted to the Monitoring service.
type MetricDataDetails struct {
// The source service or application emitting the metric.
// A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. Custom metrics can't use the following reserved prefixes: `oci_` and `oracle_`
// Avoid entering confidential information.
// Example: `my_namespace`
Namespace *string `mandatory:"true" json:"namespace"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to use for metrics.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the metric.
// A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs.
// Avoid entering confidential information.
// Example: `my_app.success_rate`
Name *string `mandatory:"true" json:"name"`
// Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.
// Each dimension takes the form of a key-value pair.
// A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256.
// A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512.
// Empty strings are not allowed for keys or values. Avoid entering confidential information.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"true" json:"dimensions"`
// A list of metric values with timestamps. At least one data point is required per call.
// For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).
Datapoints []Datapoint `mandatory:"true" json:"datapoints"`
// Resource group to assign to the metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Avoid entering confidential information.
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// Properties describing metrics. These are not part of the unique fields identifying the metric.
// Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256.
// Example: `"unit": "bytes"`
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m MetricDataDetails) String() string
func (m MetricDataDetails) ValidateEnumValue() (bool, error)
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
MonitoringClient a client for Monitoring
type MonitoringClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewMonitoringClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client MonitoringClient, err error)
NewMonitoringClientWithConfigurationProvider Creates a new default Monitoring client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewMonitoringClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client MonitoringClient, err error)
NewMonitoringClientWithOboToken Creates a new default Monitoring client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client MonitoringClient) ChangeAlarmCompartment(ctx context.Context, request ChangeAlarmCompartmentRequest) (response ChangeAlarmCompartmentResponse, err error)
ChangeAlarmCompartment Moves an alarm into a different compartment within the same tenancy. For more information, see Moving an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ChangeAlarmCompartment.go.html to see an example of how to use ChangeAlarmCompartment API.
func (client *MonitoringClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client MonitoringClient) CreateAlarm(ctx context.Context, request CreateAlarmRequest) (response CreateAlarmResponse, err error)
CreateAlarm Creates a new alarm in the specified compartment. For more information, see Creating an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/CreateAlarm.go.html to see an example of how to use CreateAlarm API.
func (client MonitoringClient) CreateAlarmSuppression(ctx context.Context, request CreateAlarmSuppressionRequest) (response CreateAlarmSuppressionResponse, err error)
CreateAlarmSuppression Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific). For more information, see Adding an Alarm-wide Suppression (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/add-alarm-suppression.htm) and Adding a Dimension-Specific Alarm Suppression (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/CreateAlarmSuppression.go.html to see an example of how to use CreateAlarmSuppression API.
func (client MonitoringClient) DeleteAlarm(ctx context.Context, request DeleteAlarmRequest) (response DeleteAlarmResponse, err error)
DeleteAlarm Deletes the specified alarm. For more information, see Deleting an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/delete-alarm.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/DeleteAlarm.go.html to see an example of how to use DeleteAlarm API.
func (client MonitoringClient) DeleteAlarmSuppression(ctx context.Context, request DeleteAlarmSuppressionRequest) (response DeleteAlarmSuppressionResponse, err error)
DeleteAlarmSuppression Deletes the specified alarm suppression. For more information, see Removing an Alarm-wide Suppression (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/remove-alarm-suppression.htm) and Removing a Dimension-Specific Alarm Suppression (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/DeleteAlarmSuppression.go.html to see an example of how to use DeleteAlarmSuppression API.
func (client MonitoringClient) GetAlarm(ctx context.Context, request GetAlarmRequest) (response GetAlarmResponse, err error)
GetAlarm Gets the specified alarm. For more information, see Getting an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarm.go.html to see an example of how to use GetAlarm API.
func (client MonitoringClient) GetAlarmHistory(ctx context.Context, request GetAlarmHistoryRequest) (response GetAlarmHistoryResponse, err error)
GetAlarmHistory Get the history of the specified alarm. For more information, see Getting History of an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-history.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarmHistory.go.html to see an example of how to use GetAlarmHistory API.
func (client MonitoringClient) GetAlarmSuppression(ctx context.Context, request GetAlarmSuppressionRequest) (response GetAlarmSuppressionResponse, err error)
GetAlarmSuppression Gets the specified alarm suppression. For more information, see Getting an Alarm-wide Suppression (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/GetAlarmSuppression.go.html to see an example of how to use GetAlarmSuppression API.
func (client MonitoringClient) ListAlarmSuppressions(ctx context.Context, request ListAlarmSuppressionsRequest) (response ListAlarmSuppressionsResponse, err error)
ListAlarmSuppressions Lists alarm suppressions for the specified alarm. For more information, see Listing Alarm Suppressions (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarmSuppressions.go.html to see an example of how to use ListAlarmSuppressions API.
func (client MonitoringClient) ListAlarms(ctx context.Context, request ListAlarmsRequest) (response ListAlarmsResponse, err error)
ListAlarms Lists the alarms for the specified compartment. For more information, see Listing Alarms (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarms.go.html to see an example of how to use ListAlarms API.
func (client MonitoringClient) ListAlarmsStatus(ctx context.Context, request ListAlarmsStatusRequest) (response ListAlarmsStatusResponse, err error)
ListAlarmsStatus List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. Optionally filter by resource or status value. For more information, see Listing Alarm Statuses (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListAlarmsStatus.go.html to see an example of how to use ListAlarmsStatus API. A default retry strategy applies to this operation ListAlarmsStatus()
func (client MonitoringClient) ListMetrics(ctx context.Context, request ListMetricsRequest) (response ListMetricsResponse, err error)
ListMetrics Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For more information, see Listing Metric Definitions (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-metric.htm). For information about metrics, see Metrics Overview (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/ListMetrics.go.html to see an example of how to use ListMetrics API.
func (client MonitoringClient) PostMetricData(ctx context.Context, request PostMetricDataRequest) (response PostMetricDataResponse, err error)
PostMetricData Publishes raw metric data points to the Monitoring service. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). For more information about publishing metrics, see Publishing Custom Metrics (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm) and Custom Metrics Walkthrough (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm). For information about developing a metric-posting client, see Developer Guide (https://docs.oracle.com/iaas/Content/API/Concepts/devtoolslanding.htm). For an example client, see MonitoringMetricPostExample.java (https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). Per-call limits information follows. * Dimensions per metric group*. Maximum: 20. Minimum: 1. * Unique metric streams*. Maximum: 50. * Transactions Per Second (TPS) per-tenancy limit for this operation: 50. *A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. For more information about metric-related concepts, see Monitoring Concepts (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts). **Note:** The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example: https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/PostMetricData.go.html to see an example of how to use PostMetricData API.
func (client MonitoringClient) RemoveAlarmSuppression(ctx context.Context, request RemoveAlarmSuppressionRequest) (response RemoveAlarmSuppressionResponse, err error)
RemoveAlarmSuppression Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/remove-alarm-suppression.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/RemoveAlarmSuppression.go.html to see an example of how to use RemoveAlarmSuppression API.
func (client MonitoringClient) RetrieveDimensionStates(ctx context.Context, request RetrieveDimensionStatesRequest) (response RetrieveDimensionStatesResponse, err error)
RetrieveDimensionStates Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. Optionally filter by status value and one or more dimension key-value pairs. For more information, see Listing Metric Stream Status in an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/RetrieveDimensionStates.go.html to see an example of how to use RetrieveDimensionStates API.
func (client *MonitoringClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client MonitoringClient) SummarizeAlarmSuppressionHistory(ctx context.Context, request SummarizeAlarmSuppressionHistoryRequest) (response SummarizeAlarmSuppressionHistoryResponse, err error)
SummarizeAlarmSuppressionHistory Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see Getting Suppression History for an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/summarize-alarm-suppression-history.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/SummarizeAlarmSuppressionHistory.go.html to see an example of how to use SummarizeAlarmSuppressionHistory API.
func (client MonitoringClient) SummarizeMetricsData(ctx context.Context, request SummarizeMetricsDataRequest) (response SummarizeMetricsDataResponse, err error)
SummarizeMetricsData Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-landing.htm) and Creating a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/SummarizeMetricsData.go.html to see an example of how to use SummarizeMetricsData API.
func (client MonitoringClient) UpdateAlarm(ctx context.Context, request UpdateAlarmRequest) (response UpdateAlarmResponse, err error)
UpdateAlarm Updates the specified alarm. For more information, see Updating an Alarm (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm.htm). For important limits information, see Limits on Monitoring (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/UpdateAlarm.go.html to see an example of how to use UpdateAlarm API.
PostMetricDataDetails An array of metric objects containing raw metric data points to be posted to the Monitoring service.
type PostMetricDataDetails struct {
// A metric object containing raw metric data points to be posted to the Monitoring service.
MetricData []MetricDataDetails `mandatory:"true" json:"metricData"`
// Batch atomicity behavior. Requires either partial or full pass of input validation for
// metric objects in PostMetricData requests. The default value of NON_ATOMIC requires a
// partial pass: at least one metric object in the request must pass input validation, and
// any objects that failed validation are identified in the returned summary, along with
// their error messages. A value of ATOMIC requires a full pass: all metric objects in
// the request must pass input validation.
// Example: `NON_ATOMIC`
BatchAtomicity PostMetricDataDetailsBatchAtomicityEnum `mandatory:"false" json:"batchAtomicity,omitempty"`
}
func (m PostMetricDataDetails) String() string
func (m PostMetricDataDetails) ValidateEnumValue() (bool, error)
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
PostMetricDataDetailsBatchAtomicityEnum Enum with underlying type: string
type PostMetricDataDetailsBatchAtomicityEnum string
Set of constants representing the allowable values for PostMetricDataDetailsBatchAtomicityEnum
const (
PostMetricDataDetailsBatchAtomicityAtomic PostMetricDataDetailsBatchAtomicityEnum = "ATOMIC"
PostMetricDataDetailsBatchAtomicityNonAtomic PostMetricDataDetailsBatchAtomicityEnum = "NON_ATOMIC"
)
func GetMappingPostMetricDataDetailsBatchAtomicityEnum(val string) (PostMetricDataDetailsBatchAtomicityEnum, bool)
GetMappingPostMetricDataDetailsBatchAtomicityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPostMetricDataDetailsBatchAtomicityEnumValues() []PostMetricDataDetailsBatchAtomicityEnum
GetPostMetricDataDetailsBatchAtomicityEnumValues Enumerates the set of values for PostMetricDataDetailsBatchAtomicityEnum
PostMetricDataRequest wrapper for the PostMetricData operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/PostMetricData.go.html to see an example of how to use PostMetricDataRequest.
type PostMetricDataRequest struct {
// An array of metric objects containing raw metric data points to be posted to the Monitoring service.
PostMetricDataDetails `contributesTo:"body"`
// 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 optional Content-Encoding header that defines the content encodings that were applied to the payload.
ContentEncoding *string `mandatory:"false" contributesTo:"header" name:"content-encoding"`
// 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 PostMetricDataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PostMetricDataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PostMetricDataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PostMetricDataRequest) String() string
func (request PostMetricDataRequest) ValidateEnumValue() (bool, error)
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
PostMetricDataResponse wrapper for the PostMetricData operation
type PostMetricDataResponse struct {
// The underlying http response
RawResponse *http.Response
// The PostMetricDataResponseDetails instance
PostMetricDataResponseDetails `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"`
}
func (response PostMetricDataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PostMetricDataResponse) String() string
PostMetricDataResponseDetails The response object returned from a PostMetricData operation.
type PostMetricDataResponseDetails struct {
// The number of metric objects that failed input validation.
FailedMetricsCount *int `mandatory:"true" json:"failedMetricsCount"`
// A list of records identifying metric objects that failed input validation
// and the reasons for the failures.
FailedMetrics []FailedMetricRecord `mandatory:"false" json:"failedMetrics"`
}
func (m PostMetricDataResponseDetails) String() string
func (m PostMetricDataResponseDetails) ValidateEnumValue() (bool, error)
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
Recurrence Alarm suppression recurring schedule. Only one recurrence condition is supported within the list of preconditions for a suppression (`suppressionConditions`).
type Recurrence struct {
// Frequency and start time of the recurring suppression. The format follows
// the iCalendar specification (RFC 5545, section 3.3.10) (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10).
// Supported rule parts:
// * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only.
// * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`.
// * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`.
SuppressionRecurrence *string `mandatory:"true" json:"suppressionRecurrence"`
// Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours).
SuppressionDuration *string `mandatory:"true" json:"suppressionDuration"`
}
func (m Recurrence) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Recurrence) String() string
func (m Recurrence) ValidateEnumValue() (bool, error)
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
RemoveAlarmSuppressionRequest wrapper for the RemoveAlarmSuppression operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/RemoveAlarmSuppression.go.html to see an example of how to use RemoveAlarmSuppressionRequest.
type RemoveAlarmSuppressionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
AlarmId *string `mandatory:"true" contributesTo:"path" name:"alarmId"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// 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 RemoveAlarmSuppressionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveAlarmSuppressionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveAlarmSuppressionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveAlarmSuppressionRequest) String() string
func (request RemoveAlarmSuppressionRequest) ValidateEnumValue() (bool, error)
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
RemoveAlarmSuppressionResponse wrapper for the RemoveAlarmSuppression operation
type RemoveAlarmSuppressionResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 RemoveAlarmSuppressionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveAlarmSuppressionResponse) String() string
RetrieveDimensionStatesDetails The configuration details for retrieving the alarm state entries. Filter retrieved alarm state entries by status value and dimension key-value pairs.
type RetrieveDimensionStatesDetails struct {
// A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs.
// If you specify `"availabilityDomain": "phx-ad-1"` but the alarm state entry corresponds to the set `"availabilityDomain": "phx-ad-1"`
// and `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`, then no results are returned.
DimensionFilters map[string]string `mandatory:"false" json:"dimensionFilters"`
// A filter to return only alarm state entries that match the status value.
// Example: `FIRING`
Status AlarmDimensionStatesEntryStatusEnum `mandatory:"false" json:"status,omitempty"`
}
func (m RetrieveDimensionStatesDetails) String() string
func (m RetrieveDimensionStatesDetails) ValidateEnumValue() (bool, error)
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
RetrieveDimensionStatesRequest wrapper for the RetrieveDimensionStates operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/RetrieveDimensionStates.go.html to see an example of how to use RetrieveDimensionStatesRequest.
type RetrieveDimensionStatesRequest struct {
// The OCID (https://docs.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"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Default: 1000
// Example: 500
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The configuration details for retrieving the current alarm status of each metric stream.
RetrieveDimensionStatesDetails `contributesTo:"body"`
// 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 RetrieveDimensionStatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveDimensionStatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveDimensionStatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveDimensionStatesRequest) String() string
func (request RetrieveDimensionStatesRequest) ValidateEnumValue() (bool, error)
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
RetrieveDimensionStatesResponse wrapper for the RetrieveDimensionStates operation
type RetrieveDimensionStatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AlarmDimensionStatesCollection instances
AlarmDimensionStatesCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response RetrieveDimensionStatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveDimensionStatesResponse) String() string
SummarizeAlarmSuppressionHistoryDetails The configuration details for returning history of suppressions for the specified alarm.
type SummarizeAlarmSuppressionHistoryDetails struct {
// A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs.
// If you specify {"availabilityDomain": "phx-ad-1"}
// and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"},
// then this alarm will be included for suppression.
// Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
Dimensions map[string]string `mandatory:"false" json:"dimensions"`
// A filter to return only entries with "timeSuppressFrom" time occurring on or after the specified time.
// The value cannot be a future time.
// Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeSuppressFromGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" json:"timeSuppressFromGreaterThanOrEqualTo"`
// A filter to return only entries with "timeSuppressFrom" time occurring before the specified time.
// The value cannot be a future time.
// Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeSuppressFromLessThan *common.SDKTime `mandatory:"false" json:"timeSuppressFromLessThan"`
}
func (m SummarizeAlarmSuppressionHistoryDetails) String() string
func (m SummarizeAlarmSuppressionHistoryDetails) ValidateEnumValue() (bool, error)
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
SummarizeAlarmSuppressionHistoryRequest wrapper for the SummarizeAlarmSuppressionHistory operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/SummarizeAlarmSuppressionHistory.go.html to see an example of how to use SummarizeAlarmSuppressionHistoryRequest.
type SummarizeAlarmSuppressionHistoryRequest struct {
// The OCID (https://docs.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"`
// 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.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Default: 1000
// Example: 500
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// summarize history details
SummarizeAlarmSuppressionHistoryDetails `contributesTo:"body"`
// 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 SummarizeAlarmSuppressionHistoryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeAlarmSuppressionHistoryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeAlarmSuppressionHistoryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeAlarmSuppressionHistoryRequest) String() string
func (request SummarizeAlarmSuppressionHistoryRequest) ValidateEnumValue() (bool, error)
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
SummarizeAlarmSuppressionHistoryResponse wrapper for the SummarizeAlarmSuppressionHistory operation
type SummarizeAlarmSuppressionHistoryResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AlarmSuppressionHistoryItemCollection instances
AlarmSuppressionHistoryItemCollection `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, next page of results remains.
// For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results remains.
// For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}
func (response SummarizeAlarmSuppressionHistoryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeAlarmSuppressionHistoryResponse) String() string
SummarizeMetricsDataDetails The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
type SummarizeMetricsDataDetails struct {
// The source service or application to use when searching for metric data points to aggregate.
// Example: `oci_computeagent`
Namespace *string `mandatory:"true" json:"namespace"`
// The Monitoring Query Language (MQL) expression to use when searching for metric data points to
// aggregate. The query must specify a metric, statistic, and interval.
// Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges.
// You can optionally specify dimensions and grouping functions.
// When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash (`\`) character.
// Supported grouping functions: `grouping()`, `groupBy()`.
// Construct your query to avoid exceeding limits on returned data. See MetricData.
// For details about Monitoring Query Language (MQL), see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
// Example 1: `CpuUtilization[1m].sum()`
// Example 2 (escaped double quotes for value string): `CpuUtilization[1m]{resourceId = \"<var><instance_OCID></var>\"}.max()`
Query *string `mandatory:"true" json:"query"`
// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The beginning of the time range to use when searching for metric data points.
// Format is defined by RFC3339. The response includes metric data points for the startTime.
// Default value: the timestamp 3 hours before the call was sent.
// Example: `2023-02-01T01:02:29.600Z`
StartTime *common.SDKTime `mandatory:"false" json:"startTime"`
// The end of the time range to use when searching for metric data points.
// Format is defined by RFC3339. The response excludes metric data points for the endTime.
// Default value: the timestamp representing when the call was sent.
// Example: `2023-02-01T02:02:29.600Z`
EndTime *common.SDKTime `mandatory:"false" json:"endTime"`
// The time between calculated aggregation windows. Use with the query interval to vary the
// frequency for returning aggregated data points. For example, use a query interval of
// 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute
// frequency. The resolution must be equal or less than the interval in the query. The default
// resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.
// Example: `5m`
Resolution *string `mandatory:"false" json:"resolution"`
}
func (m SummarizeMetricsDataDetails) String() string
func (m SummarizeMetricsDataDetails) ValidateEnumValue() (bool, error)
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
SummarizeMetricsDataRequest wrapper for the SummarizeMetricsData operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/SummarizeMetricsData.go.html to see an example of how to use SummarizeMetricsDataRequest.
type SummarizeMetricsDataRequest struct {
// The OCID (https://docs.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"`
// The dimensions used to filter for metrics.
SummarizeMetricsDataDetails `contributesTo:"body"`
// 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"`
// 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 SummarizeMetricsDataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeMetricsDataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeMetricsDataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeMetricsDataRequest) String() string
func (request SummarizeMetricsDataRequest) ValidateEnumValue() (bool, error)
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
SummarizeMetricsDataResponse wrapper for the SummarizeMetricsData operation
type SummarizeMetricsDataResponse struct {
// The underlying http response
RawResponse *http.Response
// The []MetricData instance
Items []MetricData `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"`
}
func (response SummarizeMetricsDataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeMetricsDataResponse) String() string
Suppression The configuration details for an alarm-wide suppression. For dimension-specific suppressions, see AlarmSuppression. For information about alarms, see Alarms Overview (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview).
type Suppression struct {
// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T01:02:29.600Z`
TimeSuppressFrom *common.SDKTime `mandatory:"true" json:"timeSuppressFrom"`
// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
// Example: `2023-02-01T02:02:29.600Z`
TimeSuppressUntil *common.SDKTime `mandatory:"true" json:"timeSuppressUntil"`
// Human-readable reason for suppressing alarm notifications.
// It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Oracle recommends including tracking information for the event or associated work,
// such as a ticket number.
// Example: `Planned outage due to change IT-1234.`
Description *string `mandatory:"false" json:"description"`
}
func (m Suppression) String() string
func (m Suppression) ValidateEnumValue() (bool, error)
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
SuppressionCondition Precondition for an alarm suppression within the suppression date and time range (`timeSuppressFrom` to `timeSuppressUntil`).
type SuppressionCondition interface {
}
SuppressionConditionConditionTypeEnum Enum with underlying type: string
type SuppressionConditionConditionTypeEnum string
Set of constants representing the allowable values for SuppressionConditionConditionTypeEnum
const (
SuppressionConditionConditionTypeRecurrence SuppressionConditionConditionTypeEnum = "RECURRENCE"
)
func GetMappingSuppressionConditionConditionTypeEnum(val string) (SuppressionConditionConditionTypeEnum, bool)
GetMappingSuppressionConditionConditionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSuppressionConditionConditionTypeEnumValues() []SuppressionConditionConditionTypeEnum
GetSuppressionConditionConditionTypeEnumValues Enumerates the set of values for SuppressionConditionConditionTypeEnum
UpdateAlarmDetails The configuration details for updating an alarm.
type UpdateAlarmDetails struct {
// A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// This value determines the title of each alarm notification.
// Example: `High CPU Utilization`
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric
// being evaluated by the alarm.
MetricCompartmentId *string `mandatory:"false" json:"metricCompartmentId"`
// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can
// only be set to true when metricCompartmentId 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, the alarm evaluates metrics from only the compartment specified
// in metricCompartmentId. Default is false.
// Example: `true`
MetricCompartmentIdInSubtree *bool `mandatory:"false" json:"metricCompartmentIdInSubtree"`
// The source service or application emitting the metric that is evaluated by the alarm.
// Example: `oci_computeagent`
Namespace *string `mandatory:"false" json:"namespace"`
// Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric.
// A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
// Avoid entering confidential information.
// Example: `frontend-fleet`
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// 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 depend on the specified time range. More
// interval values are supported for smaller time ranges. You can optionally
// specify dimensions and grouping functions.
// Also, you can customize the
// absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm).
// Supported grouping functions: `grouping()`, `groupBy()`.
// For information about writing MQL expressions, see
// Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm).
// For details about MQL, see
// Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).
// For available dimensions, review the metric definition for the supported service. See
// Supported Services (https://docs.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()
// -----
// Example of absence alarm with custom absence detection period of 20 hours:
// -----
//
// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)
//
// -----
Query *string `mandatory:"false" json:"query"`
// The time between calculated aggregation windows for the alarm. Supported value: `1m`
Resolution *string `mandatory:"false" json:"resolution"`
// The period of time that the condition defined in the alarm must persist before the alarm state
// changes from "OK" to "FIRING". For example, a value of 5 minutes means that the
// alarm must persist in breaching the condition for five minutes before the alarm updates its
// state to "FIRING".
// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
// Under the default value of PT1M, the first evaluation that breaches the alarm updates the
// state to "FIRING".
// The alarm updates its status to "OK" when the breaching condition has been clear for
// the most recent minute.
// Example: `PT5M`
PendingDuration *string `mandatory:"false" json:"pendingDuration"`
// The perceived severity of the alarm with regard to the affected system.
// Example: `CRITICAL`
Severity AlarmSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// The human-readable content of the delivered alarm notification.
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// Oracle recommends providing guidance
// to operators for resolving the alarm condition. Consider adding links to standard runbook
// practices. Avoid entering confidential information.
// Example: `High CPU usage alert. Follow runbook instructions for resolution.`
Body *string `mandatory:"false" json:"body"`
// When set to `true`, splits alarm notifications per metric stream.
// When set to `false`, groups alarm notifications across metric streams.
IsNotificationsPerMetricDimensionEnabled *bool `mandatory:"false" json:"isNotificationsPerMetricDimensionEnabled"`
// The format to use for alarm notifications. The formats are:
// * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format.
// * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only.
// * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only.
MessageFormat UpdateAlarmDetailsMessageFormatEnum `mandatory:"false" json:"messageFormat,omitempty"`
// A list of destinations for alarm notifications.
// Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
// of a related resource, such as a NotificationTopic.
// Supported destination services: Notifications, Streaming.
// Limit: One destination per supported destination service.
Destinations []string `mandatory:"false" json:"destinations"`
// The frequency for re-submitting alarm notifications, if the alarm keeps firing without
// interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours.
// Minimum: PT1M. Maximum: P30D.
// Default value: null (notifications are not re-submitted).
// Example: `PT2H`
RepeatNotificationDuration *string `mandatory:"false" json:"repeatNotificationDuration"`
// The configuration details for suppressing an alarm.
Suppression *Suppression `mandatory:"false" json:"suppression"`
// Whether the alarm is enabled.
// Example: `true`
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// 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"`
// A set of overrides that control evaluations of the alarm.
// Each override can specify values for query, severity, body, and pending duration.
// When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`),
// and then evaluates the alarm's base values (`ruleName` value of `BASE`).
Overrides []AlarmOverride `mandatory:"false" json:"overrides"`
// Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
// Default value is `BASE`. For information about alarm overrides, see AlarmOverride.
RuleName *string `mandatory:"false" json:"ruleName"`
// The version of the alarm notification to be delivered. Allowed value: `1.X`
// The value must start with a number (up to four digits), followed by a period and an uppercase X.
NotificationVersion *string `mandatory:"false" json:"notificationVersion"`
// Customizable notification title (`title` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
NotificationTitle *string `mandatory:"false" json:"notificationTitle"`
// Customizable slack period to wait for metric ingestion before evaluating the alarm.
// Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H`
// for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M.
// For more information about the slack period, see
// About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
EvaluationSlackDuration *string `mandatory:"false" json:"evaluationSlackDuration"`
// Customizable alarm summary (`alarmSummary` alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)).
// Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm).
// The alarm summary appears within the body of the alarm message and in responses to
// ListAlarmsStatus
// GetAlarmHistory and
// RetrieveDimensionStates.
AlarmSummary *string `mandatory:"false" json:"alarmSummary"`
}
func (m UpdateAlarmDetails) String() string
func (m UpdateAlarmDetails) ValidateEnumValue() (bool, error)
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
UpdateAlarmDetailsMessageFormatEnum Enum with underlying type: string
type UpdateAlarmDetailsMessageFormatEnum string
Set of constants representing the allowable values for UpdateAlarmDetailsMessageFormatEnum
const (
UpdateAlarmDetailsMessageFormatRaw UpdateAlarmDetailsMessageFormatEnum = "RAW"
UpdateAlarmDetailsMessageFormatPrettyJson UpdateAlarmDetailsMessageFormatEnum = "PRETTY_JSON"
UpdateAlarmDetailsMessageFormatOnsOptimized UpdateAlarmDetailsMessageFormatEnum = "ONS_OPTIMIZED"
)
func GetMappingUpdateAlarmDetailsMessageFormatEnum(val string) (UpdateAlarmDetailsMessageFormatEnum, bool)
GetMappingUpdateAlarmDetailsMessageFormatEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateAlarmDetailsMessageFormatEnumValues() []UpdateAlarmDetailsMessageFormatEnum
GetUpdateAlarmDetailsMessageFormatEnumValues Enumerates the set of values for UpdateAlarmDetailsMessageFormatEnum
UpdateAlarmRequest wrapper for the UpdateAlarm operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/monitoring/UpdateAlarm.go.html to see an example of how to use UpdateAlarmRequest.
type UpdateAlarmRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
AlarmId *string `mandatory:"true" contributesTo:"path" name:"alarmId"`
// Document for updating an alarm.
UpdateAlarmDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// 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 UpdateAlarmRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAlarmRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAlarmRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAlarmRequest) String() string
func (request UpdateAlarmRequest) ValidateEnumValue() (bool, error)
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
UpdateAlarmResponse wrapper for the UpdateAlarm operation
type UpdateAlarmResponse struct {
// The underlying http response
RawResponse *http.Response
// The Alarm instance
Alarm `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 UpdateAlarmResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAlarmResponse) String() string