MetricSpecificationV1 Class

Package:

com.azure.resourcemanager.databoxedge.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-databoxedge:1.0.0-beta.3

• java.lang.Object
• • com.azure.resourcemanager.databoxedge.models.MetricSpecificationV1

Implements

JsonSerializable<MetricSpecificationV1>

public final class MetricSpecificationV1
implements JsonSerializable<MetricSpecificationV1>

Metric specification version 1.

Constructor Summary

Constructor	Description
MetricSpecificationV1()	Creates an instance of MetricSpecificationV1 class.

Method Summary

Modifier and Type	Method and Description
MetricAggregationType	aggregationType() Get the aggregationType property: Metric aggregation type.
MetricCategory	category() Get the category property: Metric category.
List<MetricDimensionV1>	dimensions() Get the dimensions property: Metric dimensions, other than default dimension which is resource.
String	displayDescription() Get the displayDescription property: Description of the metric to be displayed.
String	displayName() Get the displayName property: Display name of the metric.
Boolean	fillGapWithZero() Get the fillGapWithZero property: Set true to fill the gaps with zero.
static MetricSpecificationV1	fromJson(JsonReader jsonReader) Reads an instance of MetricSpecificationV1 from the JsonReader.
String	name() Get the name property: Name of the metric.
String	resourceIdDimensionNameOverride() Get the resourceIdDimensionNameOverride property: Resource name override.
List<MetricAggregationType>	supportedAggregationTypes() Get the supportedAggregationTypes property: Support metric aggregation type.
List<TimeGrain>	supportedTimeGrainTypes() Get the supportedTimeGrainTypes property: Support granularity of metrics.
JsonWriter	toJson(JsonWriter jsonWriter)
MetricUnit	unit() Get the unit property: Metric units.
void	validate() Validates the instance.
MetricSpecificationV1	withAggregationType(MetricAggregationType aggregationType) Set the aggregationType property: Metric aggregation type.
MetricSpecificationV1	withCategory(MetricCategory category) Set the category property: Metric category.
MetricSpecificationV1	withDimensions(List<MetricDimensionV1> dimensions) Set the dimensions property: Metric dimensions, other than default dimension which is resource.
MetricSpecificationV1	withDisplayDescription(String displayDescription) Set the displayDescription property: Description of the metric to be displayed.
MetricSpecificationV1	withDisplayName(String displayName) Set the displayName property: Display name of the metric.
MetricSpecificationV1	withFillGapWithZero(Boolean fillGapWithZero) Set the fillGapWithZero property: Set true to fill the gaps with zero.
MetricSpecificationV1	withName(String name) Set the name property: Name of the metric.
MetricSpecificationV1	withResourceIdDimensionNameOverride(String resourceIdDimensionNameOverride) Set the resourceIdDimensionNameOverride property: Resource name override.
MetricSpecificationV1	withSupportedAggregationTypes(List<MetricAggregationType> supportedAggregationTypes) Set the supportedAggregationTypes property: Support metric aggregation type.
MetricSpecificationV1	withSupportedTimeGrainTypes(List<TimeGrain> supportedTimeGrainTypes) Set the supportedTimeGrainTypes property: Support granularity of metrics.
MetricSpecificationV1	withUnit(MetricUnit unit) Set the unit property: Metric units.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricSpecificationV1

public MetricSpecificationV1()

Creates an instance of MetricSpecificationV1 class.

Method Details

aggregationType

public MetricAggregationType aggregationType()

Get the aggregationType property: Metric aggregation type.

Returns:

the aggregationType value.

category

public MetricCategory category()

Get the category property: Metric category.

Returns:

the category value.

dimensions

public List<MetricDimensionV1> dimensions()

Get the dimensions property: Metric dimensions, other than default dimension which is resource.

Returns:

the dimensions value.

displayDescription

public String displayDescription()

Get the displayDescription property: Description of the metric to be displayed.

Returns:

the displayDescription value.

displayName

public String displayName()

Get the displayName property: Display name of the metric.

Returns:

the displayName value.

fillGapWithZero

public Boolean fillGapWithZero()

Get the fillGapWithZero property: Set true to fill the gaps with zero.

Returns:

the fillGapWithZero value.

fromJson

public static MetricSpecificationV1 fromJson(JsonReader jsonReader)

Reads an instance of MetricSpecificationV1 from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MetricSpecificationV1 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 MetricSpecificationV1.

name

public String name()

Get the name property: Name of the metric.

Returns:

the name value.

resourceIdDimensionNameOverride

public String resourceIdDimensionNameOverride()

Get the resourceIdDimensionNameOverride property: Resource name override.

Returns:

the resourceIdDimensionNameOverride value.

supportedAggregationTypes

public List<MetricAggregationType> supportedAggregationTypes()

Get the supportedAggregationTypes property: Support metric aggregation type.

Returns:

the supportedAggregationTypes value.

supportedTimeGrainTypes

public List<TimeGrain> supportedTimeGrainTypes()

Get the supportedTimeGrainTypes property: Support granularity of metrics.

Returns:

the supportedTimeGrainTypes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

unit

public MetricUnit unit()

Get the unit property: Metric units.

Returns:

the unit value.

validate

public void validate()

Validates the instance.

withAggregationType

public MetricSpecificationV1 withAggregationType(MetricAggregationType aggregationType)

Set the aggregationType property: Metric aggregation type.

Parameters:

aggregationType - the aggregationType value to set.

Returns:

the MetricSpecificationV1 object itself.

withCategory

public MetricSpecificationV1 withCategory(MetricCategory category)

Set the category property: Metric category.

Parameters:

category - the category value to set.

Returns:

the MetricSpecificationV1 object itself.

withDimensions

public MetricSpecificationV1 withDimensions(List<MetricDimensionV1> dimensions)

Set the dimensions property: Metric dimensions, other than default dimension which is resource.

Parameters:

dimensions - the dimensions value to set.

Returns:

the MetricSpecificationV1 object itself.

withDisplayDescription

public MetricSpecificationV1 withDisplayDescription(String displayDescription)

Set the displayDescription property: Description of the metric to be displayed.

Parameters:

displayDescription - the displayDescription value to set.

Returns:

the MetricSpecificationV1 object itself.

withDisplayName

public MetricSpecificationV1 withDisplayName(String displayName)

Set the displayName property: Display name of the metric.

Parameters:

displayName - the displayName value to set.

Returns:

the MetricSpecificationV1 object itself.

withFillGapWithZero

public MetricSpecificationV1 withFillGapWithZero(Boolean fillGapWithZero)

Set the fillGapWithZero property: Set true to fill the gaps with zero.

Parameters:

fillGapWithZero - the fillGapWithZero value to set.

Returns:

the MetricSpecificationV1 object itself.

withName

public MetricSpecificationV1 withName(String name)

Set the name property: Name of the metric.

Parameters:

name - the name value to set.

Returns:

the MetricSpecificationV1 object itself.

withResourceIdDimensionNameOverride

public MetricSpecificationV1 withResourceIdDimensionNameOverride(String resourceIdDimensionNameOverride)

Set the resourceIdDimensionNameOverride property: Resource name override.

Parameters:

resourceIdDimensionNameOverride - the resourceIdDimensionNameOverride value to set.

Returns:

the MetricSpecificationV1 object itself.

withSupportedAggregationTypes

public MetricSpecificationV1 withSupportedAggregationTypes(List<MetricAggregationType> supportedAggregationTypes)

Set the supportedAggregationTypes property: Support metric aggregation type.

Parameters:

supportedAggregationTypes - the supportedAggregationTypes value to set.

Returns:

the MetricSpecificationV1 object itself.

withSupportedTimeGrainTypes

public MetricSpecificationV1 withSupportedTimeGrainTypes(List<TimeGrain> supportedTimeGrainTypes)

Set the supportedTimeGrainTypes property: Support granularity of metrics.

Parameters:

supportedTimeGrainTypes - the supportedTimeGrainTypes value to set.

Returns:

the MetricSpecificationV1 object itself.

withUnit

public MetricSpecificationV1 withUnit(MetricUnit unit)

Set the unit property: Metric units.

Parameters:

unit - the unit value to set.

Returns:

the MetricSpecificationV1 object itself.