Package com.vmware.aria.operations.definition

Class MetricAttributeBuilder

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String getLabel() Label that is displayed in the VMware Aria Operations UI.
      final Unit setLabel(String label) Label that is displayed in the VMware Aria Operations UI.
      final SdkUnit getUnit() Specifies what unit this metric is returned in.
      final Unit setUnit(SdkUnit unit) Specifies what unit this metric is returned in.
      final Boolean isRate() Declares this attribute as a rate (e.g., kilobytes per second).
      final Unit setRate(Boolean isRate) Declares this attribute as a rate (e.g., kilobytes per second).
      final Boolean isDiscrete() Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point).
      final Unit setDiscrete(Boolean isDiscrete) Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point).
      final Boolean isKpi() If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
      final Unit setKpi(Boolean isKpi) If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.
      final Boolean isImpact() If set, this attribute will never be the 'root cause' of an issue.
      final Unit setImpact(Boolean isImpact) If set, this attribute will never be the 'root cause' of an issue.
      final Boolean isKeyAttribute() True if the attribute should be shown in some object summary widgets in the UI.
      final Unit setKeyAttribute(Boolean isKeyAttribute) True if the attribute should be shown in some object summary widgets in the UI.
      final String getKey() Used to identify the parameter.
      final MetricAttribute build(Integer dashboardOrder)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MetricAttributeBuilder

        MetricAttributeBuilder(String key)

    • Method Detail

      • getLabel

         final String getLabel()

        Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

      • setLabel

         final Unit setLabel(String label)

        Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

      • getUnit

         final SdkUnit getUnit()

        Specifies what unit this metric is returned in. This allows the UI to display the units in a consistent manner, and perform conversions when appropriate.

      • setUnit

         final Unit setUnit(SdkUnit unit)

        Specifies what unit this metric is returned in. This allows the UI to display the units in a consistent manner, and perform conversions when appropriate.

      • isRate

         final Boolean isRate()

        Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this will be set automatically. Otherwise, defaults to False.

      • setRate

         final Unit setRate(Boolean isRate)

        Declares this attribute as a rate (e.g., kilobytes per second). If a unit is specified, this will be set automatically. Otherwise, defaults to False.

      • isDiscrete

         final Boolean isDiscrete()

        Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always be set to True.

      • setDiscrete

         final Unit setDiscrete(Boolean isDiscrete)

        Declares that this attribute's range of values is discrete (integer) rather than continuous (floating point). Defaults to False, unless 'is_string' is set, in which case it will always be set to True.

      • isKpi

         final Boolean isKpi()

        If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.

      • setKpi

         final Unit setKpi(Boolean isKpi)

        If set, threshold breaches for this metric will be used in the calculation of the object's 'Self - Health Score' metric, which can affect the 'Anomalies' Badge.

      • isImpact

         final Boolean isImpact()

        If set, this attribute will never be the 'root cause' of an issue. For example, it could be a proxy to a root cause, but not the root cause itself.

      • setImpact

         final Unit setImpact(Boolean isImpact)

        If set, this attribute will never be the 'root cause' of an issue. For example, it could be a proxy to a root cause, but not the root cause itself.

      • isKeyAttribute

         final Boolean isKeyAttribute()

        True if the attribute should be shown in some object summary widgets in the UI.

      • setKeyAttribute

         final Unit setKeyAttribute(Boolean isKeyAttribute)

        True if the attribute should be shown in some object summary widgets in the UI.

      • getKey

         final String getKey()

        Used to identify the parameter.