EventSubscription (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.docdb.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>

Detailed information about an event to which you have subscribed.

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 customer account that is associated with the Amazon DocumentDB event notification subscription.
`String`	`custSubscriptionId()` The Amazon DocumentDB event notification subscription ID.
`Boolean`	`enabled()` A Boolean value indicating whether the subscription is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`eventCategoriesList()` A list of event categories for the Amazon DocumentDB event notification subscription.
`String`	`eventSubscriptionArn()` The Amazon Resource Name (ARN) for the event 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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EventSubscription.Builder>`	`serializableBuilderClass()`
`String`	`snsTopicArn()` The topic ARN of the Amazon DocumentDB event notification subscription.
`List<String>`	`sourceIdsList()` A list of source IDs for the Amazon DocumentDB event notification subscription.
`String`	`sourceType()` The source type for the Amazon DocumentDB event notification subscription.
`String`	`status()` The status of the Amazon DocumentDB event notification subscription.
`String`	`subscriptionCreationTime()` The time at which the Amazon DocumentDB event notification subscription was created.
`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 customer account that is associated with the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
  - custSubscriptionId
```
public final String custSubscriptionId()
```
    The Amazon DocumentDB event notification subscription ID.
    
    Returns:
    
    The Amazon DocumentDB event notification subscription ID.
  - snsTopicArn
```
public final String snsTopicArn()
```
    The topic ARN of the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The topic ARN of the Amazon DocumentDB event notification subscription.
  - status
```
public final String status()
```
    The status of the Amazon DocumentDB event notification subscription.
    
    Constraints:
    
    Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist
    
    The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
    
    Returns:
    
    The status of the Amazon DocumentDB event notification subscription.
    
    Constraints:
    
    Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist
    
    The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
  - subscriptionCreationTime
```
public final String subscriptionCreationTime()
```
    The time at which the Amazon DocumentDB event notification subscription was created.
    
    Returns:
    
    The time at which the Amazon DocumentDB event notification subscription was created.
  - sourceType
```
public final String sourceType()
```
    The source type for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The source type for the Amazon DocumentDB event notification subscription.
  - 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 source IDs for the Amazon DocumentDB 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 source IDs for the Amazon DocumentDB 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()
```
    A list of event categories for the Amazon DocumentDB 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 hasEventCategoriesList() method.
    
    Returns:
    
    A list of event categories for the Amazon DocumentDB event notification subscription.
  - enabled
```
public final Boolean enabled()
```
    A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
    
    Returns:
    
    A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
  - eventSubscriptionArn
```
public final String eventSubscriptionArn()
```
    The Amazon Resource Name (ARN) for the event subscription.
    
    Returns:
    
    The Amazon Resource Name (ARN) 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

enabled

eventSubscriptionArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields