Interface UpdateAlertRequest.Builder

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

  • Method Details

    • spaceId

      UpdateAlertRequest.Builder spaceId(String spaceId)

      The unique ID of the space.

      Parameters:
      spaceId - The unique ID of the space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alertId

      UpdateAlertRequest.Builder alertId(String alertId)

      The alert to update.

      Parameters:
      alertId - The alert to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileId

      UpdateAlertRequest.Builder profileId(String profileId)

      The ID of the access profile associated with the alert.

      Parameters:
      profileId - The ID of the access profile associated with the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateAlertRequest.Builder name(String name)

      A new display name for the alert. Omit to leave the name unchanged (apply-if-present / PATCH). Same constraints as CreateAlert.name; the name is not the alert's identity, so a rename never changes the alertId.

      Parameters:
      name - A new display name for the alert. Omit to leave the name unchanged (apply-if-present / PATCH). Same constraints as CreateAlert.name; the name is not the alert's identity, so a rename never changes the alertId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateAlertRequest.Builder description(String description)

      A new description of the alert. Omit to leave unchanged.

      Parameters:
      description - A new description of the alert. Omit to leave unchanged.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rule

      UpdateAlertRequest.Builder rule(Rule rule)

      The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: query, condition, evaluation and noData are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See AlertCondition and AlertEvaluation.

      Parameters:
      rule - The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: query, condition, evaluation and noData are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See AlertCondition and AlertEvaluation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rule

      default UpdateAlertRequest.Builder rule(Consumer<Rule.Builder> rule)

      The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: query, condition, evaluation and noData are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See AlertCondition and AlertEvaluation.

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

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

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

    • notificationsEnabled

      UpdateAlertRequest.Builder notificationsEnabled(Boolean notificationsEnabled)

      Whether actions (notifications) are enabled for this alert. Omitted = leave existing value unchanged.

      Parameters:
      notificationsEnabled - Whether actions (notifications) are enabled for this alert. Omitted = leave existing value unchanged.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      UpdateAlertRequest.Builder notificationRules(Collection<NotificationRule> notificationRules)

      Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).

      Parameters:
      notificationRules - Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      UpdateAlertRequest.Builder notificationRules(NotificationRule... notificationRules)

      Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).

      Parameters:
      notificationRules - Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      UpdateAlertRequest.Builder notificationRules(Consumer<NotificationRule.Builder>... notificationRules)

      Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationRules(List<NotificationRule>).

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

    • overrideConfiguration

      UpdateAlertRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAlertRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.