MetricSpecification Class

Package:

com.azure.resourcemanager.webpubsub.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-webpubsub:1.1.0

• java.lang.Object
• • com.azure.resourcemanager.webpubsub.models.MetricSpecification

Implements

JsonSerializable<MetricSpecification>

public final class MetricSpecification
implements JsonSerializable<MetricSpecification>

Specifications of the Metrics for Azure Monitoring.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	aggregationType() Get the aggregationType property: Only provide one value for this field.
String	category() Get the category property: The name of the metric category that the metric belongs to.
List<Dimension>	dimensions() Get the dimensions property: The dimensions of the metrics.
String	displayDescription() Get the displayDescription property: Localized friendly description of the metric.
String	displayName() Get the displayName property: Localized friendly display name of the metric.
String	fillGapWithZero() Get the fillGapWithZero property: Optional.
static MetricSpecification	fromJson(JsonReader jsonReader) Reads an instance of MetricSpecification from the JsonReader.
String	name() Get the name property: Name of the metric.
JsonWriter	toJson(JsonWriter jsonWriter)
String	unit() Get the unit property: The unit that makes sense for the metric.
void	validate() Validates the instance.
MetricSpecification	withAggregationType(String aggregationType) Set the aggregationType property: Only provide one value for this field.
MetricSpecification	withCategory(String category) Set the category property: The name of the metric category that the metric belongs to.
MetricSpecification	withDimensions(List<Dimension> dimensions) Set the dimensions property: The dimensions of the metrics.
MetricSpecification	withDisplayDescription(String displayDescription) Set the displayDescription property: Localized friendly description of the metric.
MetricSpecification	withDisplayName(String displayName) Set the displayName property: Localized friendly display name of the metric.
MetricSpecification	withFillGapWithZero(String fillGapWithZero) Set the fillGapWithZero property: Optional.
MetricSpecification	withName(String name) Set the name property: Name of the metric.
MetricSpecification	withUnit(String unit) Set the unit property: The unit that makes sense for the metric.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricSpecification

public MetricSpecification()

Creates an instance of MetricSpecification class.

Method Details

aggregationType

public String aggregationType()

Get the aggregationType property: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.

Returns:

the aggregationType value.

category

public String category()

Get the category property: The name of the metric category that the metric belongs to. A metric can only belong to a single category.

Returns:

the category value.

dimensions

public List<Dimension> dimensions()

Get the dimensions property: The dimensions of the metrics.

Returns:

the dimensions value.

displayDescription

public String displayDescription()

Get the displayDescription property: Localized friendly description of the metric.

Returns:

the displayDescription value.

displayName

public String displayName()

Get the displayName property: Localized friendly display name of the metric.

Returns:

the displayName value.

fillGapWithZero

public String fillGapWithZero()

Get the fillGapWithZero property: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

Returns:

the fillGapWithZero value.

fromJson

public static MetricSpecification fromJson(JsonReader jsonReader)

Reads an instance of MetricSpecification from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

name

public String name()

Get the name property: Name of the metric.

Returns:

the name value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

unit

public String unit()

Get the unit property: The unit that makes sense for the metric.

Returns:

the unit value.

validate

public void validate()

Validates the instance.

withAggregationType

public MetricSpecification withAggregationType(String aggregationType)

Set the aggregationType property: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.

Parameters:

aggregationType - the aggregationType value to set.

Returns:

the MetricSpecification object itself.

withCategory

public MetricSpecification withCategory(String category)

Set the category property: The name of the metric category that the metric belongs to. A metric can only belong to a single category.

Parameters:

category - the category value to set.

Returns:

the MetricSpecification object itself.

withDimensions

public MetricSpecification withDimensions(List<Dimension> dimensions)

Set the dimensions property: The dimensions of the metrics.

Parameters:

dimensions - the dimensions value to set.

Returns:

the MetricSpecification object itself.

withDisplayDescription

public MetricSpecification withDisplayDescription(String displayDescription)

Set the displayDescription property: Localized friendly description of the metric.

Parameters:

displayDescription - the displayDescription value to set.

Returns:

the MetricSpecification object itself.

withDisplayName

public MetricSpecification withDisplayName(String displayName)

Set the displayName property: Localized friendly display name of the metric.

Parameters:

displayName - the displayName value to set.

Returns:

the MetricSpecification object itself.

withFillGapWithZero

public MetricSpecification withFillGapWithZero(String fillGapWithZero)

Set the fillGapWithZero property: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

Parameters:

fillGapWithZero - the fillGapWithZero value to set.

Returns:

the MetricSpecification object itself.

withName

public MetricSpecification withName(String name)

Set the name property: Name of the metric.

Parameters:

name - the name value to set.

Returns:

the MetricSpecification object itself.

withUnit

public MetricSpecification withUnit(String unit)

Set the unit property: The unit that makes sense for the metric.

Parameters:

unit - the unit value to set.

Returns:

the MetricSpecification object itself.