Package software.amazon.awssdk.services.docdb.model

Class ModifyEventSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.ModifyEventSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyEventSubscriptionRequest.Builder,ModifyEventSubscriptionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyEventSubscriptionRequest
extends DocDbRequest
implements ToCopyableBuilder<ModifyEventSubscriptionRequest.Builder,ModifyEventSubscriptionRequest>

Represents the input to ModifyEventSubscription.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyEventSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifyEventSubscriptionRequest.Builder	builder()
Boolean	enabled()	A Boolean value; set to true to activate the subscription.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventCategories()	A list of event categories for a SourceType that you want to subscribe to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventCategories()	For responses, this returns true if the service returned a value for the EventCategories property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyEventSubscriptionRequest.Builder>	serializableBuilderClass()
String	snsTopicArn()	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
String	sourceType()	The type of source that is generating the events.
String	subscriptionName()	The name of the Amazon DocumentDB event notification subscription.
ModifyEventSubscriptionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

subscriptionName

public final String subscriptionName()

The name of the Amazon DocumentDB event notification subscription.

Returns:

The name of the Amazon DocumentDB event notification subscription.

snsTopicArn

public final String snsTopicArn()

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Returns:

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

sourceType

public final String sourceType()

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

Returns:

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

hasEventCategories

public final boolean hasEventCategories()

For responses, this returns true if the service returned a value for the EventCategories 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.

eventCategories

public final List<String> eventCategories()

A list of event categories for a SourceType that you want to subscribe to.

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

Returns:

A list of event categories for a SourceType that you want to subscribe to.

enabled

public final Boolean enabled()

A Boolean value; set to true to activate the subscription.

Returns:

A Boolean value; set to true to activate the subscription.

toBuilder

public ModifyEventSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyEventSubscriptionRequest.Builder,ModifyEventSubscriptionRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static ModifyEventSubscriptionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo