Class RequestBasedServiceLevelIndicatorConfig

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

This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.

See Also:

  • Method Details

    • requestBasedSliMetricConfig

      public final RequestBasedServiceLevelIndicatorMetricConfig requestBasedSliMetricConfig()

      Use this structure to specify the metric to be used for the SLO.

      Returns:
      Use this structure to specify the metric to be used for the SLO.

    • metricThreshold

      public final Double metricThreshold()

      The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.

      Returns:
      The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.

    • comparisonOperator

      public final ServiceLevelIndicatorComparisonOperator comparisonOperator()

      The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.

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

      Returns:
      The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.
      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.

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

      Returns:
      The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.
      See Also:

    • toBuilder

      public RequestBasedServiceLevelIndicatorConfig.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<RequestBasedServiceLevelIndicatorConfig.Builder,RequestBasedServiceLevelIndicatorConfig>
      Returns:
      a builder for type T

    • builder

      public static RequestBasedServiceLevelIndicatorConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RequestBasedServiceLevelIndicatorConfig.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.