Package com.oracle.bmc.monitoring.model

Class Metric

java.lang.Object

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

com.oracle.bmc.monitoring.model.Metric

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class Metric
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The properties that define a metric.

For information about metrics, see Metrics Overview.
Note: Objects should always be created or deserialized using the Metric.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 Metric.Builder, which maintain a set of all explicitly set fields called Metric.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	Metric.Builder

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
Metric(String name, String namespace, String resourceGroup, String compartmentId, Map<String,String> dimensions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Metric.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment containing the resources monitored by the metric.
Map<String,String>	getDimensions()	Qualifiers provided in a metric definition.
String	getName()	The name of the metric.
String	getNamespace()	The source service or application emitting the metric.
String	getResourceGroup()	Resource group provided with the posted metric.
int	hashCode()
Metric.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

Metric

@Deprecated
@ConstructorProperties({"name","namespace","resourceGroup","compartmentId","dimensions"})
public Metric(String name,
              String namespace,
              String resourceGroup,
              String compartmentId,
              Map<String,String> dimensions)

Deprecated.

Method Detail

builder

public static Metric.Builder builder()

Create a new builder.

toBuilder

public Metric.Builder toBuilder()

getName

public String getName()

The name of the metric.

Example: CpuUtilization

Returns:

the value

getNamespace

public String getNamespace()

The source service or application emitting the metric.

Example: oci_computeagent

Returns:

the value

getResourceGroup

public String getResourceGroup()

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

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the resources monitored by the metric.

Returns:

the value

getDimensions

public Map<String,String> getDimensions()

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"}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel