Interface ServiceLevelObjectiveBudgetReport.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ServiceLevelObjectiveBudgetReport.Builder,ServiceLevelObjectiveBudgetReport>, SdkBuilder<ServiceLevelObjectiveBudgetReport.Builder,ServiceLevelObjectiveBudgetReport>, SdkPojo
Enclosing class:
ServiceLevelObjectiveBudgetReport
@Mutable @NotThreadSafe public static interface ServiceLevelObjectiveBudgetReport.Builder extends SdkPojo, CopyableBuilder<ServiceLevelObjectiveBudgetReport.Builder,ServiceLevelObjectiveBudgetReport>

  • Method Details

    • arn

      ServiceLevelObjectiveBudgetReport.Builder arn(String arn)

      The ARN of the SLO that this report is for.

      Parameters:
      arn - The ARN of the SLO that this report is for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ServiceLevelObjectiveBudgetReport.Builder name(String name)

      The name of the SLO that this report is for.

      Parameters:
      name - The name of the SLO that this report is for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationType

      ServiceLevelObjectiveBudgetReport.Builder evaluationType(String evaluationType)

      Displays whether this budget report is for a period-based SLO or a request-based SLO.

      Parameters:
      evaluationType - Displays whether this budget report is for a period-based SLO or a request-based SLO.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evaluationType

      ServiceLevelObjectiveBudgetReport.Builder evaluationType(EvaluationType evaluationType)

      Displays whether this budget report is for a period-based SLO or a request-based SLO.

      Parameters:
      evaluationType - Displays whether this budget report is for a period-based SLO or a request-based SLO.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • budgetStatus

      ServiceLevelObjectiveBudgetReport.Builder budgetStatus(String 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 specified start and end times were before the SLO was created, or that attainment data is missing.

      Parameters:
      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 specified start and end times were before the SLO was created, or that attainment data is missing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • budgetStatus

      ServiceLevelObjectiveBudgetReport.Builder budgetStatus(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 specified start and end times were before the SLO was created, or that attainment data is missing.

      Parameters:
      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 specified start and end times were before the SLO was created, or that attainment data is missing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attainment

      ServiceLevelObjectiveBudgetReport.Builder attainment(Double attainment)

      A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

      If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

      If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.

      Parameters:
      attainment - A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

      If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

      If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalBudgetSeconds

      ServiceLevelObjectiveBudgetReport.Builder totalBudgetSeconds(Integer totalBudgetSeconds)

      The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.

      Parameters:
      totalBudgetSeconds - The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • budgetSecondsRemaining

      ServiceLevelObjectiveBudgetReport.Builder budgetSecondsRemaining(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.

      This field is included only if the SLO is a period-based SLO.

      Parameters:
      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.

      This field is included only if the SLO is a period-based SLO.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalBudgetRequests

      ServiceLevelObjectiveBudgetReport.Builder totalBudgetRequests(Integer totalBudgetRequests)

      This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.

      This number can go up and down between reports with different time stamps, based on both how many total requests occur.

      Parameters:
      totalBudgetRequests - This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.

      This number can go up and down between reports with different time stamps, based on both how many total requests occur.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • budgetRequestsRemaining

      ServiceLevelObjectiveBudgetReport.Builder budgetRequestsRemaining(Integer budgetRequestsRemaining)

      This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.

      This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.

      Parameters:
      budgetRequestsRemaining - This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.

      This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sli

      ServiceLevelObjectiveBudgetReport.Builder sli(ServiceLevelIndicator sli)

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

      Parameters:
      sli - A structure that contains information about the performance metric that this SLO monitors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sli

      default ServiceLevelObjectiveBudgetReport.Builder sli(Consumer<ServiceLevelIndicator.Builder> sli)

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

      This is a convenience method that creates an instance of the ServiceLevelIndicator.Builder avoiding the need to create one manually via ServiceLevelIndicator.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sli(ServiceLevelIndicator).

      Parameters:
      sli - a consumer that will call methods on ServiceLevelIndicator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestBasedSli

      ServiceLevelObjectiveBudgetReport.Builder requestBasedSli(RequestBasedServiceLevelIndicator requestBasedSli)
      Sets the value of the RequestBasedSli property for this object.
      Parameters:
      requestBasedSli - The new value for the RequestBasedSli property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestBasedSli

      default ServiceLevelObjectiveBudgetReport.Builder requestBasedSli(Consumer<RequestBasedServiceLevelIndicator.Builder> requestBasedSli)
      Sets the value of the RequestBasedSli property for this object. This is a convenience method that creates an instance of the RequestBasedServiceLevelIndicator.Builder avoiding the need to create one manually via RequestBasedServiceLevelIndicator.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requestBasedSli(RequestBasedServiceLevelIndicator).

      Parameters:
      requestBasedSli - a consumer that will call methods on RequestBasedServiceLevelIndicator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • goal

      ServiceLevelObjectiveBudgetReport.Builder goal(Goal goal)
      Sets the value of the Goal property for this object.
      Parameters:
      goal - The new value for the Goal property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • goal

      default ServiceLevelObjectiveBudgetReport.Builder goal(Consumer<Goal.Builder> goal)
      Sets the value of the Goal property for this object. This is a convenience method that creates an instance of the Goal.Builder avoiding the need to create one manually via Goal.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to goal(Goal).

      Parameters:
      goal - a consumer that will call methods on Goal.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: