Interface ServiceLevelObjectiveBudgetReport.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ServiceLevelObjectiveBudgetReport.Builder,
,ServiceLevelObjectiveBudgetReport> SdkBuilder<ServiceLevelObjectiveBudgetReport.Builder,
,ServiceLevelObjectiveBudgetReport> SdkPojo
- Enclosing class:
ServiceLevelObjectiveBudgetReport
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the SLO that this report is for.attainment
(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.budgetSecondsRemaining
(Integer budgetSecondsRemaining) The budget amount remaining before the SLO status becomesBREACHING
, at the time specified in theTimestemp
parameter of the request.budgetStatus
(String budgetStatus) The status of this SLO, as it relates to the error budget for the entire time interval.budgetStatus
(ServiceLevelObjectiveBudgetStatus budgetStatus) The status of this SLO, as it relates to the error budget for the entire time interval.goal
(Consumer<Goal.Builder> goal) Sets the value of the Goal property for this object.Sets the value of the Goal property for this object.The name of the SLO that this report is for.A structure that contains information about the performance metric that this SLO monitors.sli
(ServiceLevelIndicator sli) A structure that contains information about the performance metric that this SLO monitors.totalBudgetSeconds
(Integer totalBudgetSeconds) The total number of seconds in the error budget for the interval.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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.
-
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 inTimeStamp
. -
WARNING
means that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp
. -
BREACHED
means that the SLO's budget was exhausted, as of the time that you specified inTimeStamp
. -
INSUFFICIENT_DATA
means that the specifed 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 inTimeStamp
. -
WARNING
means that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp
. -
BREACHED
means that the SLO's budget was exhausted, as of the time that you specified inTimeStamp
. -
INSUFFICIENT_DATA
means that the specifed 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 inTimeStamp
. -
WARNING
means that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp
. -
BREACHED
means that the SLO's budget was exhausted, as of the time that you specified inTimeStamp
. -
INSUFFICIENT_DATA
means that the specifed 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 inTimeStamp
. -
WARNING
means that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp
. -
BREACHED
means that the SLO's budget was exhausted, as of the time that you specified inTimeStamp
. -
INSUFFICIENT_DATA
means that the specifed 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
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
totalBudgetSeconds
The total number of seconds in the error budget for the interval.
- Parameters:
totalBudgetSeconds
- The total number of seconds in the error budget for the interval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
budgetSecondsRemaining
The budget amount remaining before the SLO status becomes
BREACHING
, at the time specified in theTimestemp
parameter of the request. If this value is negative, then the SLO is already inBREACHING
status.- Parameters:
budgetSecondsRemaining
- The budget amount remaining before the SLO status becomesBREACHING
, at the time specified in theTimestemp
parameter of the request. If this value is negative, then the SLO is already inBREACHING
status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
A structure that contains information about the performance metric that this SLO monitors.
This is a convenience method that creates an instance of theServiceLevelIndicator.Builder
avoiding the need to create one manually viaServiceLevelIndicator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosli(ServiceLevelIndicator)
.- Parameters:
sli
- a consumer that will call methods onServiceLevelIndicator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Sets the value of the Goal property for this object. This is a convenience method that creates an instance of theGoal.Builder
avoiding the need to create one manually viaGoal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togoal(Goal)
.- Parameters:
goal
- a consumer that will call methods onGoal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-