Class EventSubscription

java.lang.Object
software.amazon.awssdk.services.redshift.model.EventSubscription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventSubscription.Builder,EventSubscription>
@Generated("software.amazon.awssdk:codegen") public final class EventSubscription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventSubscription.Builder,EventSubscription>

Describes event subscriptions.

See Also:

  • Method Details

    • customerAwsId

      public final String customerAwsId()

      The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

      Returns:
      The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

    • custSubscriptionId

      public final String custSubscriptionId()

      The name of the Amazon Redshift event notification subscription.

      Returns:
      The name of the Amazon Redshift event notification subscription.

    • snsTopicArn

      public final String snsTopicArn()

      The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

    • status

      public final String status()

      The status of the Amazon Redshift event notification subscription.

      Constraints:

      • Can be one of the following: active | no-permission | topic-not-exist

      • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

      Returns:
      The status of the Amazon Redshift event notification subscription.

      Constraints:

      • Can be one of the following: active | no-permission | topic-not-exist

      • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

    • subscriptionCreationTime

      public final Instant subscriptionCreationTime()

      The date and time the Amazon Redshift event notification subscription was created.

      Returns:
      The date and time the Amazon Redshift event notification subscription was created.

    • sourceType

      public final String sourceType()

      The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

      Returns:
      The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

    • hasSourceIdsList

      public final boolean hasSourceIdsList()
      For responses, this returns true if the service returned a value for the SourceIdsList 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.

    • sourceIdsList

      public final List<String> sourceIdsList()

      A list of the sources that publish events to the Amazon Redshift event notification subscription.

      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 hasSourceIdsList() method.

      Returns:
      A list of the sources that publish events to the Amazon Redshift event notification subscription.

    • hasEventCategoriesList

      public final boolean hasEventCategoriesList()
      For responses, this returns true if the service returned a value for the EventCategoriesList 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.

    • eventCategoriesList

      public final List<String> eventCategoriesList()

      The list of Amazon Redshift event categories specified in the event notification subscription.

      Values: Configuration, Management, Monitoring, Security, Pending

      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 hasEventCategoriesList() method.

      Returns:
      The list of Amazon Redshift event categories specified in the event notification subscription.

      Values: Configuration, Management, Monitoring, Security, Pending

    • severity

      public final String severity()

      The event severity specified in the Amazon Redshift event notification subscription.

      Values: ERROR, INFO

      Returns:
      The event severity specified in the Amazon Redshift event notification subscription.

      Values: ERROR, INFO

    • enabled

      public final Boolean enabled()

      A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

      Returns:
      A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

    • 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 List<Tag> tags()

      The list of tags for the event subscription.

      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 list of tags for the event subscription.

    • toBuilder

      public EventSubscription.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<EventSubscription.Builder,EventSubscription>
      Returns:
      a builder for type T

    • builder

      public static EventSubscription.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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