Package software.amazon.awssdk.services.applicationsignals.model

Class ServiceLevelObjectiveBudgetReport

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

A structure containing an SLO budget report that you have requested.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the SLO that this report is for.

      Returns:
      The ARN of the SLO that this report is for.

    • name

      public final String name()

      The name of the SLO that this report is for.

      Returns:
      The name of the SLO that this report is for.

    • budgetStatus

      public final ServiceLevelObjectiveBudgetStatus budgetStatus()

      The status of this SLO, as it relates to the error budget for the entire time interval.

      • OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.

      • WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.

      • BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.

      • INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.

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

      Returns:
      The status of this SLO, as it relates to the error budget for the entire time interval.

      • OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.

      • WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.

      • BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.

      • INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.

      See Also:

    • budgetStatusAsString

      public final String budgetStatusAsString()

      The status of this SLO, as it relates to the error budget for the entire time interval.

      • OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.

      • WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.

      • BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.

      • INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.

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

      Returns:
      The status of this SLO, as it relates to the error budget for the entire time interval.

      • OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.

      • WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.

      • BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.

      • INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.

      See Also:

    • attainment

      public final Double attainment()

      A number between 0 and 100 that represents the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

      Returns:
      A number between 0 and 100 that represents the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

    • totalBudgetSeconds

      public final Integer totalBudgetSeconds()

      The total number of seconds in the error budget for the interval.

      Returns:
      The total number of seconds in the error budget for the interval.

    • budgetSecondsRemaining

      public final Integer budgetSecondsRemaining()

      The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.

      Returns:
      The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.

    • sli

      public final ServiceLevelIndicator sli()

      A structure that contains information about the performance metric that this SLO monitors.

      Returns:
      A structure that contains information about the performance metric that this SLO monitors.

    • goal

      public final Goal goal()
      Returns the value of the Goal property for this object.
      Returns:
      The value of the Goal property for this object.

    • toBuilder

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

    • builder

      public static ServiceLevelObjectiveBudgetReport.Builder builder()

    • serializableBuilderClass

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