Interface Goal.Builder

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

  • Method Details

    • interval

      Goal.Builder interval(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • interval

      default Goal.Builder interval(Consumer<Interval.Builder> 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.

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

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

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

    • attainmentGoal

      Goal.Builder attainmentGoal(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • warningThreshold

      Goal.Builder warningThreshold(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.