com.amazonaws.services.docdb.model

Class ModifyEventSubscriptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdb.model.ModifyEventSubscriptionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyEventSubscriptionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input to ModifyEventSubscription.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyEventSubscriptionRequest()

Method Summary

Modifier and Type	Method and Description
ModifyEventSubscriptionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getEnabled() A Boolean value; set to true to activate the subscription.
List<String>	getEventCategories() A list of event categories for a SourceType that you want to subscribe to.
String	getSnsTopicArn() The Amazon Resource Name (ARN) of the SNS topic created for event notification.
String	getSourceType() The type of source that is generating the events.
String	getSubscriptionName() The name of the Amazon DocumentDB event notification subscription.
int	hashCode()
Boolean	isEnabled() A Boolean value; set to true to activate the subscription.
void	setEnabled(Boolean enabled) A Boolean value; set to true to activate the subscription.
void	setEventCategories(Collection<String> eventCategories) A list of event categories for a SourceType that you want to subscribe to.
void	setSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.
void	setSourceType(String sourceType) The type of source that is generating the events.
void	setSubscriptionName(String subscriptionName) The name of the Amazon DocumentDB event notification subscription.
String	toString() Returns a string representation of this object.
ModifyEventSubscriptionRequest	withEnabled(Boolean enabled) A Boolean value; set to true to activate the subscription.
ModifyEventSubscriptionRequest	withEventCategories(Collection<String> eventCategories) A list of event categories for a SourceType that you want to subscribe to.
ModifyEventSubscriptionRequest	withEventCategories(String... eventCategories) A list of event categories for a SourceType that you want to subscribe to.
ModifyEventSubscriptionRequest	withSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.
ModifyEventSubscriptionRequest	withSourceType(String sourceType) The type of source that is generating the events.
ModifyEventSubscriptionRequest	withSubscriptionName(String subscriptionName) The name of the Amazon DocumentDB event notification subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyEventSubscriptionRequest

public ModifyEventSubscriptionRequest()

Method Detail

setSubscriptionName

public void setSubscriptionName(String subscriptionName)

The name of the Amazon DocumentDB event notification subscription.

Parameters:

subscriptionName - The name of the Amazon DocumentDB event notification subscription.

getSubscriptionName

public String getSubscriptionName()

The name of the Amazon DocumentDB event notification subscription.

Returns:

The name of the Amazon DocumentDB event notification subscription.

withSubscriptionName

public ModifyEventSubscriptionRequest withSubscriptionName(String subscriptionName)

The name of the Amazon DocumentDB event notification subscription.

Parameters:

subscriptionName - The name of the Amazon DocumentDB event notification subscription.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSnsTopicArn

public void setSnsTopicArn(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.

Parameters:

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.

getSnsTopicArn

public String getSnsTopicArn()

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.

withSnsTopicArn

public ModifyEventSubscriptionRequest withSnsTopicArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSourceType

public void setSourceType(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

Parameters:

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

getSourceType

public String getSourceType()

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

withSourceType

public ModifyEventSubscriptionRequest withSourceType(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getEventCategories

public List<String> getEventCategories()

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

Returns:

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

setEventCategories

public void setEventCategories(Collection<String> eventCategories)

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

Parameters:

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

withEventCategories

public ModifyEventSubscriptionRequest withEventCategories(String... eventCategories)

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

NOTE: This method appends the values to the existing list (if any). Use setEventCategories(java.util.Collection) or withEventCategories(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withEventCategories

public ModifyEventSubscriptionRequest withEventCategories(Collection<String> eventCategories)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnabled

public void setEnabled(Boolean enabled)

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

Parameters:

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

getEnabled

public Boolean getEnabled()

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

Returns:

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

withEnabled

public ModifyEventSubscriptionRequest withEnabled(Boolean enabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

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

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyEventSubscriptionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()