Class Goal

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

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

See Also:

  • Method Details

    • interval

      public final Interval interval()

      The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

      If you omit this parameter, a rolling interval of 7 days is used.

      Returns:
      The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

      If you omit this parameter, a rolling interval of 7 days is used.

    • attainmentGoal

      public final Double attainmentGoal()

      The threshold that determines if the goal is being met.

      If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

      If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

      If you omit this parameter, 99 is used to represent 99% as the attainment goal.

      Returns:
      The threshold that determines if the goal is being met.

      If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

      If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

      If you omit this parameter, 99 is used to represent 99% as the attainment goal.

    • warningThreshold

      public final Double warningThreshold()

      The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

      Returns:
      The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

    • toBuilder

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

    • builder

      public static Goal.Builder builder()

    • serializableBuilderClass

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