Class MetricSpecification
java.lang.Object
com.azure.resourcemanager.signalr.models.MetricSpecification
Specifications of the Metrics for Azure Monitoring.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the aggregationType property: Only provide one value for this field.category()
Get the category property: The name of the metric category that the metric belongs to.Get the dimensions property: The dimensions of the metrics.Get the displayDescription property: Localized friendly description of the metric.Get the displayName property: Localized friendly display name of the metric.Get the fillGapWithZero property: Optional.name()
Get the name property: Name of the metric.unit()
Get the unit property: The unit that makes sense for the metric.void
validate()
Validates the instance.withAggregationType
(String aggregationType) Set the aggregationType property: Only provide one value for this field.withCategory
(String category) Set the category property: The name of the metric category that the metric belongs to.withDimensions
(List<Dimension> dimensions) Set the dimensions property: The dimensions of the metrics.withDisplayDescription
(String displayDescription) Set the displayDescription property: Localized friendly description of the metric.withDisplayName
(String displayName) Set the displayName property: Localized friendly display name of the metric.withFillGapWithZero
(String fillGapWithZero) Set the fillGapWithZero property: Optional.Set the name property: Name of the metric.Set the unit property: The unit that makes sense for the metric.
-
Constructor Details
-
MetricSpecification
public MetricSpecification()Creates an instance of MetricSpecification class.
-
-
Method Details
-
name
Get the name property: Name of the metric.- Returns:
- the name value.
-
withName
Set the name property: Name of the metric.- Parameters:
name
- the name value to set.- Returns:
- the MetricSpecification object itself.
-
displayName
Get the displayName property: Localized friendly display name of the metric.- Returns:
- the displayName value.
-
withDisplayName
Set the displayName property: Localized friendly display name of the metric.- Parameters:
displayName
- the displayName value to set.- Returns:
- the MetricSpecification object itself.
-
displayDescription
Get the displayDescription property: Localized friendly description of the metric.- Returns:
- the displayDescription value.
-
withDisplayDescription
Set the displayDescription property: Localized friendly description of the metric.- Parameters:
displayDescription
- the displayDescription value to set.- Returns:
- the MetricSpecification object itself.
-
unit
Get the unit property: The unit that makes sense for the metric.- Returns:
- the unit value.
-
withUnit
Set the unit property: The unit that makes sense for the metric.- Parameters:
unit
- the unit value to set.- Returns:
- the MetricSpecification object itself.
-
aggregationType
Get the aggregationType property: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.- Returns:
- the aggregationType value.
-
withAggregationType
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.
-
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.
-
withFillGapWithZero
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.
-
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.
-
withCategory
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.
-
dimensions
Get the dimensions property: The dimensions of the metrics.- Returns:
- the dimensions value.
-
withDimensions
Set the dimensions property: The dimensions of the metrics.- Parameters:
dimensions
- the dimensions value to set.- Returns:
- the MetricSpecification object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-