@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public final class MetricData extends ExplicitlySetBmcModel
The set of aggregated data returned for a metric. For information about metrics, see Metrics Overview.
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, typically specific to a single resource.
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.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
Note: Objects should always be created or deserialized using the MetricData.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 MetricData.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
MetricData.Builder |
| Constructor and Description |
|---|
MetricData(String namespace,
String resourceGroup,
String compartmentId,
String name,
Map<String,String> dimensions,
Map<String,String> metadata,
String resolution,
List<AggregatedDatapoint> aggregatedDatapoints)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static MetricData.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<AggregatedDatapoint> |
getAggregatedDatapoints()
The list of timestamp-value pairs returned for the specified request.
|
String |
getCompartmentId()
The OCID of the compartment containing the
resources from which the aggregated data was returned.
|
Map<String,String> |
getDimensions()
Qualifiers provided in the definition of the returned metric.
|
Map<String,String> |
getMetadata()
The references provided in a metric definition to indicate extra information about the metric.
|
String |
getName()
The name of the metric.
|
String |
getNamespace()
The reference provided in a metric definition to indicate the source service or
application that emitted the metric.
|
String |
getResolution()
The time between calculated aggregation windows.
|
String |
getResourceGroup()
Resource group provided with the posted metric.
|
int |
hashCode() |
MetricData.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"namespace","resourceGroup","compartmentId","name","dimensions","metadata","resolution","aggregatedDatapoints"}) public MetricData(String namespace, String resourceGroup, String compartmentId, String name, Map<String,String> dimensions, Map<String,String> metadata, String resolution, List<AggregatedDatapoint> aggregatedDatapoints)
public static MetricData.Builder builder()
Create a new builder.
public MetricData.Builder toBuilder()
public String getNamespace()
The reference provided in a metric definition to indicate the source service or application that emitted the metric.
Example: oci_computeagent
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
public String getCompartmentId()
The OCID of the compartment containing the resources from which the aggregated data was returned.
public String getName()
The name of the metric.
Example: CpuUtilization
public Map<String,String> getDimensions()
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"
public Map<String,String> getMetadata()
The references provided in a metric definition to indicate extra information about the metric.
Example: "unit": "bytes"
public String getResolution()
The time between calculated aggregation windows. Use with the query interval to vary the
frequency at which aggregated data points are returned. 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
public List<AggregatedDatapoint> getAggregatedDatapoints()
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.
public String toString()
toString in class ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class ExplicitlySetBmcModelpublic int hashCode()
hashCode in class ExplicitlySetBmcModelCopyright © 2016–2022. All rights reserved.