EventSubscription (AWS Java SDK :: Services :: Amazon Redshift 2.19.0 API)

java.lang.Object
- software.amazon.awssdk.services.redshift.model.EventSubscription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EventSubscription.Builder,EventSubscription>

@Generated(value="software.amazon.awssdk:codegen")
public final class EventSubscription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventSubscription.Builder,EventSubscription>

Describes event subscriptions.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EventSubscription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EventSubscription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EventSubscription.Builder`	`builder()`
`String`	`customerAwsId()` The Amazon Web Services account associated with the Amazon Redshift event notification subscription.
`String`	`custSubscriptionId()` The name of the Amazon Redshift event notification subscription.
`Boolean`	`enabled()` A boolean value indicating whether the subscription is enabled; `true` indicates that the subscription is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`eventCategoriesList()` The list of Amazon Redshift event categories specified in the event notification subscription.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEventCategoriesList()` For responses, this returns true if the service returned a value for the EventCategoriesList property.
`int`	`hashCode()`
`boolean`	`hasSourceIdsList()` For responses, this returns true if the service returned a value for the SourceIdsList property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EventSubscription.Builder>`	`serializableBuilderClass()`
`String`	`severity()` The event severity specified in the Amazon Redshift event notification subscription.
`String`	`snsTopicArn()` The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
`List<String>`	`sourceIdsList()` A list of the sources that publish events to the Amazon Redshift event notification subscription.
`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.
`String`	`status()` The status of the Amazon Redshift event notification subscription.
`Instant`	`subscriptionCreationTime()` The date and time the Amazon Redshift event notification subscription was created.
`List<Tag>`	`tags()` The list of tags for the event subscription.
`EventSubscription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EventSubscription.Builder,EventSubscription>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class EventSubscription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

customerAwsId

custSubscriptionId

snsTopicArn

status

subscriptionCreationTime

sourceType

hasSourceIdsList

sourceIdsList

hasEventCategoriesList

eventCategoriesList

severity

enabled

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields