MetricData (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.monitoring.model.MetricData

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class MetricData
extends com.oracle.bmc.http.client.internal.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 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.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 MetricData.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 and Description

static class MetricData.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetricData.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 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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 that the aggregated data was returned from.
`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.

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

MetricData

@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)

Deprecated.

Method Detail
- builder
```
public static MetricData.Builder builder()
```
  Create a new builder.
- toBuilder
```
public MetricData.Builder toBuilder()
```
- getNamespace
```
public String getNamespace()
```
  The reference provided in a metric definition to indicate the source service or application that emitted 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 that the aggregated data was returned from.
  
  Returns:
  
  the value
- getName
```
public String getName()
```
  The name of the metric.
  
  Example: CpuUtilization
  
  Returns:
  
  the value
- getDimensions
```
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"}
  
  Returns:
  
  the value
- getMetadata
```
public Map<String,String> getMetadata()
```
  The references provided in a metric definition to indicate extra information about the metric.
  
  Example: "unit": "bytes"
  
  Returns:
  
  the value
- getResolution
```
public String getResolution()
```
  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
  
  Returns:
  
  the value
- getAggregatedDatapoints
```
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.
  
  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

Class MetricData

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MetricData

Method Detail

builder

toBuilder

getNamespace

getResourceGroup

getCompartmentId

getName

getDimensions

getMetadata

getResolution

getAggregatedDatapoints

toString

toString

equals

hashCode