Class EventSubscription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EventSubscription.Builder,
EventSubscription>
Describes an event notification subscription created by the CreateEventSubscription
operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EventSubscription.Builder
builder()
final String
The Amazon Web Services customer account associated with the DMS event notification subscription.final String
The DMS event notification subscription Id.final Boolean
enabled()
Boolean value that indicates if the event subscription is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A lists of event categories.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EventCategoriesList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SourceIdsList property.static Class
<? extends EventSubscription.Builder> final String
The topic ARN of the DMS event notification subscription.A list of source Ids for the event subscription.final String
The type of DMS resource that generates events.final String
status()
The status of the DMS event notification subscription.final String
The time the DMS event notification subscription was created.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The DMS event notification subscription Id.
- Returns:
- The DMS event notification subscription Id.
-
snsTopicArn
The topic ARN of the DMS event notification subscription.
- Returns:
- The topic ARN of the DMS event notification subscription.
-
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
The time the DMS event notification subscription was created.
- Returns:
- The time the DMS event notification subscription was created.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
Boolean value that indicates if the event subscription is enabled.
- Returns:
- Boolean value that indicates if the event subscription is enabled.
-
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 interfaceToCopyableBuilder<EventSubscription.Builder,
EventSubscription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-