Class MetricSpecification


  • public final class MetricSpecification
    extends Object
    Details about operation related to metrics.
    • Constructor Detail

      • MetricSpecification

        public MetricSpecification()
    • Method Detail

      • name

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

        public MetricSpecification withName​(String name)
        Set the name property: The 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 display name of the metric.
        Returns:
        the displayName value.
      • withDisplayName

        public MetricSpecification withDisplayName​(String displayName)
        Set the displayName property: Localized 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: The description of the metric.
        Returns:
        the displayDescription value.
      • withDisplayDescription

        public MetricSpecification withDisplayDescription​(String displayDescription)
        Set the displayDescription property: The 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 the metric is measured in.
        Returns:
        the unit value.
      • withUnit

        public MetricSpecification withUnit​(String unit)
        Set the unit property: The unit that the metric is measured in.
        Parameters:
        unit - the unit value to set.
        Returns:
        the MetricSpecification object itself.
      • aggregationType

        public String aggregationType()
        Get the aggregationType property: The type of metric aggregation.
        Returns:
        the aggregationType value.
      • withAggregationType

        public MetricSpecification withAggregationType​(String aggregationType)
        Set the aggregationType property: The type of metric aggregation.
        Parameters:
        aggregationType - the aggregationType value to set.
        Returns:
        the MetricSpecification object itself.
      • supportedAggregationTypes

        public List<MetricAggregationType> supportedAggregationTypes()
        Get the supportedAggregationTypes property: Support metric aggregation type.
        Returns:
        the supportedAggregationTypes value.
      • withSupportedAggregationTypes

        public MetricSpecification withSupportedAggregationTypes​(List<MetricAggregationType> supportedAggregationTypes)
        Set the supportedAggregationTypes property: Support metric aggregation type.
        Parameters:
        supportedAggregationTypes - the supportedAggregationTypes value to set.
        Returns:
        the MetricSpecification object itself.
      • metricClass

        public String metricClass()
        Get the metricClass property: Type of metrics.
        Returns:
        the metricClass value.
      • withMetricClass

        public MetricSpecification withMetricClass​(String metricClass)
        Set the metricClass property: Type of metrics.
        Parameters:
        metricClass - the metricClass value to set.
        Returns:
        the MetricSpecification object itself.
      • dimensions

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

        public MetricSpecification withDimensions​(List<MetricDimension> dimensions)
        Set the dimensions property: Dimensions of the metric.
        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.