Class MetricDimension


  • public final class MetricDimension
    extends Object
    Specifications of the Dimension of metrics.
    • Constructor Detail

      • MetricDimension

        public MetricDimension()
    • Method Detail

      • name

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

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

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

        public MetricDimension withDisplayName​(String displayName)
        Set the displayName property: Localized friendly display name of the dimension.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the MetricDimension object itself.
      • internalName

        public String internalName()
        Get the internalName property: Name of the dimension as it appears in MDM.
        Returns:
        the internalName value.
      • withInternalName

        public MetricDimension withInternalName​(String internalName)
        Set the internalName property: Name of the dimension as it appears in MDM.
        Parameters:
        internalName - the internalName value to set.
        Returns:
        the MetricDimension object itself.
      • toBeExportedForShoebox

        public Boolean toBeExportedForShoebox()
        Get the toBeExportedForShoebox property: A boolean flag indicating whether this dimension should be included for the shoebox export scenario.
        Returns:
        the toBeExportedForShoebox value.
      • withToBeExportedForShoebox

        public MetricDimension withToBeExportedForShoebox​(Boolean toBeExportedForShoebox)
        Set the toBeExportedForShoebox property: A boolean flag indicating whether this dimension should be included for the shoebox export scenario.
        Parameters:
        toBeExportedForShoebox - the toBeExportedForShoebox value to set.
        Returns:
        the MetricDimension object itself.
      • validate

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