Package com.azure.resourcemanager.signalr.models

Class MetricSpecification

  • public final class MetricSpecification
extends Object
    Specifications of the Metrics for Azure Monitoring.

    • Constructor Detail

      • MetricSpecification

        public MetricSpecification()

    • Method Detail

      • name

        public String name()
        Get the name property: Name of the metric.
        Returns:
        the name value.

      • 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.

      • displayName

        public String displayName()
        Get the displayName property: Localized friendly display name of the metric.
        Returns:
        the displayName value.

      • 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.

      • displayDescription

        public String displayDescription()
        Get the displayDescription property: Localized friendly description of the metric.
        Returns:
        the displayDescription value.

      • 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.

      • unit

        public String unit()
        Get the unit property: The unit that makes sense for the metric.
        Returns:
        the unit value.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • dimensions

        public List<Dimension> dimensions()
        Get the dimensions property: The dimensions of the metrics.
        Returns:
        the dimensions value.

      • 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.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.