Class CreateAlertRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatchomni.model.CloudWatchOmniRequest
software.amazon.awssdk.services.cloudwatchomni.model.CreateAlertRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAlertRequest.Builder,CreateAlertRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAlertRequest extends CloudWatchOmniRequest implements ToCopyableBuilder<CreateAlertRequest.Builder,CreateAlertRequest>

  • Method Details

    • spaceId

      public final String spaceId()

      The unique ID of the space to create the alert in.

      Returns:
      The unique ID of the space to create the alert in.

    • profileId

      public final String profileId()

      The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.

      Returns:
      The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.

    • name

      public final String name()

      Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the

      invalid reference 
      AlertId
      , so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.

      Returns:
      Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the
      invalid reference 
      AlertId
      , so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.

    • description

      public final String description()

      An optional description of the alert.

      Returns:
      An optional description of the alert.

    • rule

      public final Rule rule()

      The rule that defines how the alert is evaluated.

      Returns:
      The rule that defines how the alert is evaluated.

    • notificationsEnabled

      public final Boolean notificationsEnabled()

      Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.

      Returns:
      Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags to associate with the alert.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags to associate with the alert.

    • hasNotificationRules

      public final boolean hasNotificationRules()
      For responses, this returns true if the service returned a value for the NotificationRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notificationRules

      public final List<NotificationRule> notificationRules()

      The notification rules that determine when and where notifications are sent.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotificationRules() method.

      Returns:
      The notification rules that determine when and where notifications are sent.

    • clientToken

      public final String clientToken()

      Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.

      Returns:
      Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.

    • toBuilder

      public CreateAlertRequest.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<CreateAlertRequest.Builder,CreateAlertRequest>
      Specified by:
      toBuilder in class CloudWatchOmniRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAlertRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAlertRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.