Class CurrentMetric

java.lang.Object
software.amazon.awssdk.services.connect.model.CurrentMetric
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CurrentMetric.Builder,CurrentMetric>
@Generated("software.amazon.awssdk:codegen") public final class CurrentMetric extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CurrentMetric.Builder,CurrentMetric>

Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.

Only one of either the Name or MetricId is required.

See Also:

  • Method Details

    • name

      public final CurrentMetricName name()

      The name of the metric.

      If the service returns an enum value that is not available in the current SDK version, name will return CurrentMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The name of the metric.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the metric.

      If the service returns an enum value that is not available in the current SDK version, name will return CurrentMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The name of the metric.
      See Also:

    • metricId

      public final String metricId()

      Out of the box current metrics or custom metrics can be referenced via this field. This field is a valid AWS Connect Arn or a UUID.

      Returns:
      Out of the box current metrics or custom metrics can be referenced via this field. This field is a valid AWS Connect Arn or a UUID.

    • unit

      public final Unit unit()

      The Unit parameter is not supported for custom metrics.

      The unit for the metric.

      If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:

      The Unit parameter is not supported for custom metrics.

      The unit for the metric.

      See Also:

    • unitAsString

      public final String unitAsString()

      The Unit parameter is not supported for custom metrics.

      The unit for the metric.

      If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:

      The Unit parameter is not supported for custom metrics.

      The unit for the metric.

      See Also:

    • toBuilder

      public CurrentMetric.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CurrentMetric.Builder,CurrentMetric>
      Returns:
      a builder for type T

    • builder

      public static CurrentMetric.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CurrentMetric.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.