PartitionMetricInner Class

Package:
com.azure.resourcemanager.cosmos.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.55.0

public final class PartitionMetricInner
extends MetricInner

The metric values for a single partition.

Method Summary

Modifier and Type Method and Description
OffsetDateTime endTime()

Get the endTime property: The end time for the metric (ISO-8601 format).
static PartitionMetricInner fromJson(JsonReader jsonReader)

Reads an instance of PartitionMetricInner from the JsonReader.
List<MetricValue> metricValues()

Get the metricValues property: The metric values for the specified time window and timestep.
MetricName name()

Get the name property: The name information for the metric.
String partitionId()

Get the partitionId property: The partition id (GUID identifier) of the metric values.
String partitionKeyRangeId()

Get the partitionKeyRangeId property: The partition key range id (integer identifier) of the metric values.
OffsetDateTime startTime()

Get the startTime property: The start time for the metric (ISO-8601 format).
String timeGrain()

Get the timeGrain property: The time grain to be used to summarize the metric values.
JsonWriter toJson(JsonWriter jsonWriter)
UnitType unit()

Get the unit property: The unit of the metric.
void validate()

Validates the instance.

Methods inherited from MetricInner

endTime fromJson metricValues name startTime timeGrain toJson unit validate

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

endTime

public OffsetDateTime endTime()

Get the endTime property: The end time for the metric (ISO-8601 format).

Overrides:

PartitionMetricInner.endTime()

Returns:

the endTime value.

fromJson

public static PartitionMetricInner fromJson(JsonReader jsonReader)

Reads an instance of PartitionMetricInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PartitionMetricInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the PartitionMetricInner.

metricValues

public List<MetricValue> metricValues()

Get the metricValues property: The metric values for the specified time window and timestep.

Overrides:

PartitionMetricInner.metricValues()

Returns:

the metricValues value.

name

public MetricName name()

Get the name property: The name information for the metric.

Overrides:

PartitionMetricInner.name()

Returns:

the name value.

partitionId

public String partitionId()

Get the partitionId property: The partition id (GUID identifier) of the metric values.

Returns:

the partitionId value.

partitionKeyRangeId

public String partitionKeyRangeId()

Get the partitionKeyRangeId property: The partition key range id (integer identifier) of the metric values.

Returns:

the partitionKeyRangeId value.

startTime

public OffsetDateTime startTime()

Get the startTime property: The start time for the metric (ISO-8601 format).

Overrides:

PartitionMetricInner.startTime()

Returns:

the startTime value.

timeGrain

public String timeGrain()

Get the timeGrain property: The time grain to be used to summarize the metric values.

Overrides:

PartitionMetricInner.timeGrain()

Returns:

the timeGrain value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PartitionMetricInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

unit

public UnitType unit()

Get the unit property: The unit of the metric.

Overrides:

PartitionMetricInner.unit()

Returns:

the unit value.

validate

public void validate()

Validates the instance.

Overrides:

PartitionMetricInner.validate()

Applies to