software.amazon.awssdk.services.databasemigration.model

Class EventSubscription

java.lang.Object

software.amazon.awssdk.services.databasemigration.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 an event notification subscription created by the CreateEventSubscription operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventSubscription.Builder

Method Summary

Modifier and Type	Method and Description
static EventSubscription.Builder	builder()
String	customerAwsId() The Amazon Web Services customer account associated with the DMS event notification subscription.
String	custSubscriptionId() The DMS event notification subscription Id.
Boolean	enabled() Boolean value that indicates if the event subscription is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventCategoriesList() A lists of event categories.
<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 DMS event notification subscription.
List<String>	sourceIdsList() A list of source Ids for the event subscription.
String	sourceType() The type of DMS resource that generates events.
String	status() The status of the DMS event notification subscription.
String	subscriptionCreationTime() The time the DMS 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 associated with the DMS event notification subscription.

Returns:

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

custSubscriptionId

public final String custSubscriptionId()

The DMS event notification subscription Id.

Returns:

The DMS event notification subscription Id.

snsTopicArn

public final String snsTopicArn()

The topic ARN of the DMS event notification subscription.

Returns:

The topic ARN of the DMS event notification subscription.

status

public final String status()

The status of the DMS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

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

Returns:

The status of the DMS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

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

subscriptionCreationTime

public final String subscriptionCreationTime()

The time the DMS event notification subscription was created.

Returns:

The time the DMS event notification subscription was created.

sourceType

public final String sourceType()

The type of DMS resource that generates events.

Valid values: replication-instance | replication-server | security-group | replication-task

Returns:

The type of DMS resource that generates events.

Valid values: replication-instance | replication-server | security-group | replication-task

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

Returns:

A list of source Ids for the event 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 lists of event categories.

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 lists of event categories.

enabled

public final Boolean enabled()

Boolean value that indicates if the event subscription is enabled.

Returns:

Boolean value that indicates if the event subscription is enabled.

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