com.oracle.bmc.monitoring.model

Class MetricDataDetails

java.lang.Object

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

com.oracle.bmc.monitoring.model.MetricDataDetails

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

A metric object containing raw metric data points to be posted to the Monitoring service.
Note: Objects should always be created or deserialized using the MetricDataDetails.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 MetricDataDetails.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricDataDetails.Builder

Constructor Summary

Constructors

Constructor and Description
MetricDataDetails(String namespace, String resourceGroup, String compartmentId, String name, Map<String,String> dimensions, Map<String,String> metadata, List<Datapoint> datapoints) Deprecated.

Method Summary

Modifier and Type	Method and Description
static MetricDataDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the compartment to use for metrics.
List<Datapoint>	getDatapoints() A list of metric values with timestamps.
Map<String,String>	getDimensions() Qualifiers provided in a metric definition.
Map<String,String>	getMetadata() Properties describing metrics.
String	getName() The name of the metric.
String	getNamespace() The source service or application emitting the metric.
String	getResourceGroup() Resource group to assign to the metric.
int	hashCode()
MetricDataDetails.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

MetricDataDetails

@Deprecated
 @ConstructorProperties(value={"namespace","resourceGroup","compartmentId","name","dimensions","metadata","datapoints"})
public MetricDataDetails(String namespace,
                                                                                                                                                              String resourceGroup,
                                                                                                                                                              String compartmentId,
                                                                                                                                                              String name,
                                                                                                                                                              Map<String,String> dimensions,
                                                                                                                                                              Map<String,String> metadata,
                                                                                                                                                              List<Datapoint> datapoints)

Deprecated.

Method Detail

builder

public static MetricDataDetails.Builder builder()

Create a new builder.

toBuilder

public MetricDataDetails.Builder toBuilder()

getNamespace

public String getNamespace()

The source service or application emitting the metric.

A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. The "oci_" prefix is reserved. Avoid entering confidential information.

Example: my_namespace

Returns:

the value

getResourceGroup

public String getResourceGroup()

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

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to use for metrics.

Returns:

the value

getName

public String getName()

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. The oci_ prefix is reserved. Avoid entering confidential information.

Example: my_app.success_rate

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

Returns:

the value

getMetadata

public Map<String,String> getMetadata()

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"

Returns:

the value

getDatapoints

public List<Datapoint> getDatapoints()

A list of metric values with timestamps. At least one data point is required per call.

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