Class UpdateMetricContentRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateMetricContentRequest.Builder,UpdateMetricContentRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateMetricContentRequest extends ConnectRequest implements ToCopyableBuilder<UpdateMetricContentRequest.Builder,UpdateMetricContentRequest>
  • Method Details

    • instanceId

      public final String instanceId()

      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Returns:
      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    • metricId

      public final String metricId()

      The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version.

      Returns:
      The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version.
    • metricCalculation

      public final MetricCalculation metricCalculation()

      The updated calculation definition for the metric.

      Returns:
      The updated calculation definition for the metric.
    • unit

      public final MetricUnit unit()

      The updated display unit for the metric.

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

      Returns:
      The updated display unit for the metric.
      See Also:
    • unitAsString

      public final String unitAsString()

      The updated display unit for the metric.

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

      Returns:
      The updated display unit for the metric.
      See Also:
    • positiveTrendIndicator

      public final TrendIndicator positiveTrendIndicator()

      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

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

      Returns:
      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.
      See Also:
    • positiveTrendIndicatorAsString

      public final String positiveTrendIndicatorAsString()

      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

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

      Returns:
      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.
      See Also:
    • 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<UpdateMetricContentRequest.Builder,UpdateMetricContentRequest>
      Specified by:
      toBuilder in class ConnectRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateMetricContentRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateMetricContentRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.