Package com.oracle.bmc.autoscaling.model

Class CustomMetric

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.autoscaling.model.MetricBase

com.oracle.bmc.autoscaling.model.CustomMetric

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181001")
public final class CustomMetric
extends MetricBase

Metric details for triggering an autoscaling action based on a custom MQL query.
Note: Objects should always be created or deserialized using the CustomMetric.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CustomMetric.Builder, which maintain a set of all explicitly set fields called CustomMetric.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomMetric.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.autoscaling.model.MetricBase

MetricBase.MetricSource

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
CustomMetric(String pendingDuration, String query, String namespace, String resourceGroup, String metricCompartmentId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CustomMetric.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getMetricCompartmentId()	The OCID of the compartment containing the metrics.
String	getNamespace()	The namespace for the query.
String	getQuery()	The Monitoring Query Language (MQL) expression to evaluate for the alarm.
String	getResourceGroup()	The resource group for the query.
int	hashCode()
CustomMetric.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.autoscaling.model.MetricBase

getPendingDuration

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomMetric

@Deprecated
public CustomMetric(String pendingDuration,
                    String query,
                    String namespace,
                    String resourceGroup,
                    String metricCompartmentId)

Deprecated.

Method Detail

builder

public static CustomMetric.Builder builder()

Create a new builder.

toBuilder

public CustomMetric.Builder toBuilder()

getQuery

public String getQuery()

The Monitoring Query Language (MQL) expression to evaluate for the alarm.

The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m- 60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy().

Example of threshold alarm:

-----

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85

-----

Returns:

the value

getNamespace

public String getNamespace()

The namespace for the query.

Returns:

the value

getResourceGroup

public String getResourceGroup()

The resource group for the query.

Returns:

the value

getMetricCompartmentId

public String getMetricCompartmentId()

The OCID of the compartment containing the metrics.

Returns:

the value

toString

public String toString()

Overrides:

toString in class MetricBase

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class MetricBase

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class MetricBase

hashCode

public int hashCode()

Overrides:

hashCode in class MetricBase