Class MetricSpecification


  • public final class MetricSpecification
    extends Object
    Metric specification of operation.
    • Constructor Detail

      • MetricSpecification

        public MetricSpecification()
    • Method Detail

      • name

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

        public MetricSpecification withName​(String name)
        Set the name property: Name of metric specification.
        Parameters:
        name - the name value to set.
        Returns:
        the MetricSpecification object itself.
      • displayName

        public String displayName()
        Get the displayName property: Display name of metric specification.
        Returns:
        the displayName value.
      • withDisplayName

        public MetricSpecification withDisplayName​(String displayName)
        Set the displayName property: Display name of metric specification.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the MetricSpecification object itself.
      • displayDescription

        public String displayDescription()
        Get the displayDescription property: Display description of metric specification.
        Returns:
        the displayDescription value.
      • withDisplayDescription

        public MetricSpecification withDisplayDescription​(String displayDescription)
        Set the displayDescription property: Display description of metric specification.
        Parameters:
        displayDescription - the displayDescription value to set.
        Returns:
        the MetricSpecification object itself.
      • unit

        public String unit()
        Get the unit property: The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'.
        Returns:
        the unit value.
      • withUnit

        public MetricSpecification withUnit​(String unit)
        Set the unit property: The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'.
        Parameters:
        unit - the unit value to set.
        Returns:
        the MetricSpecification object itself.
      • aggregationType

        public String aggregationType()
        Get the aggregationType property: The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'.
        Returns:
        the aggregationType value.
      • withAggregationType

        public MetricSpecification withAggregationType​(String aggregationType)
        Set the aggregationType property: The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'.
        Parameters:
        aggregationType - the aggregationType value to set.
        Returns:
        the MetricSpecification object itself.
      • availabilities

        public List<MetricAvailability> availabilities()
        Get the availabilities property: Retention policies of a resource metric.
        Returns:
        the availabilities value.
      • withAvailabilities

        public MetricSpecification withAvailabilities​(List<MetricAvailability> availabilities)
        Set the availabilities property: Retention policies of a resource metric.
        Parameters:
        availabilities - the availabilities value to set.
        Returns:
        the MetricSpecification object itself.
      • supportedTimeGrainTypes

        public List<String> supportedTimeGrainTypes()
        Get the supportedTimeGrainTypes property: The supported time grain types for the metrics.
        Returns:
        the supportedTimeGrainTypes value.
      • withSupportedTimeGrainTypes

        public MetricSpecification withSupportedTimeGrainTypes​(List<String> supportedTimeGrainTypes)
        Set the supportedTimeGrainTypes property: The supported time grain types for the metrics.
        Parameters:
        supportedTimeGrainTypes - the supportedTimeGrainTypes value to set.
        Returns:
        the MetricSpecification object itself.
      • dimensions

        public List<DimensionProperties> dimensions()
        Get the dimensions property: The dimensions of metric.
        Returns:
        the dimensions value.
      • withDimensions

        public MetricSpecification withDimensions​(List<DimensionProperties> dimensions)
        Set the dimensions property: The dimensions of metric.
        Parameters:
        dimensions - the dimensions value to set.
        Returns:
        the MetricSpecification object itself.
      • fillGapWithZero

        public Boolean fillGapWithZero()
        Get the fillGapWithZero property: Property to specify whether to fill gap with zero.
        Returns:
        the fillGapWithZero value.
      • withFillGapWithZero

        public MetricSpecification withFillGapWithZero​(Boolean fillGapWithZero)
        Set the fillGapWithZero property: Property to specify whether to fill gap with zero.
        Parameters:
        fillGapWithZero - the fillGapWithZero value to set.
        Returns:
        the MetricSpecification object itself.
      • metricFilterPattern

        public String metricFilterPattern()
        Get the metricFilterPattern property: Pattern to filter based on name.
        Returns:
        the metricFilterPattern value.
      • withMetricFilterPattern

        public MetricSpecification withMetricFilterPattern​(String metricFilterPattern)
        Set the metricFilterPattern property: Pattern to filter based on name.
        Parameters:
        metricFilterPattern - the metricFilterPattern value to set.
        Returns:
        the MetricSpecification object itself.
      • isInternal

        public Boolean isInternal()
        Get the isInternal property: Property to specify metric is internal or not.
        Returns:
        the isInternal value.
      • withIsInternal

        public MetricSpecification withIsInternal​(Boolean isInternal)
        Set the isInternal property: Property to specify metric is internal or not.
        Parameters:
        isInternal - the isInternal value to set.
        Returns:
        the MetricSpecification object itself.
      • validate

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