EventSubscription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.docdb.model.EventSubscription

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EventSubscription
extends Object
implements Serializable, Cloneable
```
Detailed information about an event to which you have subscribed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EventSubscription()

Constructors
Constructor and Description
`EventSubscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventSubscription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomerAwsId()` The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
`String`	`getCustSubscriptionId()` The Amazon DocumentDB event notification subscription ID.
`Boolean`	`getEnabled()` A Boolean value indicating whether the subscription is enabled.
`List<String>`	`getEventCategoriesList()` A list of event categories for the Amazon DocumentDB event notification subscription.
`String`	`getEventSubscriptionArn()` The Amazon Resource Name (ARN) for the event subscription.
`String`	`getSnsTopicArn()` The topic ARN of the Amazon DocumentDB event notification subscription.
`List<String>`	`getSourceIdsList()` A list of source IDs for the Amazon DocumentDB event notification subscription.
`String`	`getSourceType()` The source type for the Amazon DocumentDB event notification subscription.
`String`	`getStatus()` The status of the Amazon DocumentDB event notification subscription.
`String`	`getSubscriptionCreationTime()` The time at which the Amazon DocumentDB event notification subscription was created.
`int`	`hashCode()`
`Boolean`	`isEnabled()` A Boolean value indicating whether the subscription is enabled.
`void`	`setCustomerAwsId(String customerAwsId)` The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
`void`	`setCustSubscriptionId(String custSubscriptionId)` The Amazon DocumentDB event notification subscription ID.
`void`	`setEnabled(Boolean enabled)` A Boolean value indicating whether the subscription is enabled.
`void`	`setEventCategoriesList(Collection<String> eventCategoriesList)` A list of event categories for the Amazon DocumentDB event notification subscription.
`void`	`setEventSubscriptionArn(String eventSubscriptionArn)` The Amazon Resource Name (ARN) for the event subscription.
`void`	`setSnsTopicArn(String snsTopicArn)` The topic ARN of the Amazon DocumentDB event notification subscription.
`void`	`setSourceIdsList(Collection<String> sourceIdsList)` A list of source IDs for the Amazon DocumentDB event notification subscription.
`void`	`setSourceType(String sourceType)` The source type for the Amazon DocumentDB event notification subscription.
`void`	`setStatus(String status)` The status of the Amazon DocumentDB event notification subscription.
`void`	`setSubscriptionCreationTime(String subscriptionCreationTime)` The time at which the Amazon DocumentDB event notification subscription was created.
`String`	`toString()` Returns a string representation of this object.
`EventSubscription`	`withCustomerAwsId(String customerAwsId)` The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withCustSubscriptionId(String custSubscriptionId)` The Amazon DocumentDB event notification subscription ID.
`EventSubscription`	`withEnabled(Boolean enabled)` A Boolean value indicating whether the subscription is enabled.
`EventSubscription`	`withEventCategoriesList(Collection<String> eventCategoriesList)` A list of event categories for the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withEventCategoriesList(String... eventCategoriesList)` A list of event categories for the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withEventSubscriptionArn(String eventSubscriptionArn)` The Amazon Resource Name (ARN) for the event subscription.
`EventSubscription`	`withSnsTopicArn(String snsTopicArn)` The topic ARN of the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withSourceIdsList(Collection<String> sourceIdsList)` A list of source IDs for the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withSourceIdsList(String... sourceIdsList)` A list of source IDs for the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withSourceType(String sourceType)` The source type for the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withStatus(String status)` The status of the Amazon DocumentDB event notification subscription.
`EventSubscription`	`withSubscriptionCreationTime(String subscriptionCreationTime)` The time at which the Amazon DocumentDB event notification subscription was created.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EventSubscription
```
public EventSubscription()
```
- Method Detail
  - setCustomerAwsId
```
public void setCustomerAwsId(String customerAwsId)
```
    The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    customerAwsId - The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
  - getCustomerAwsId
```
public String getCustomerAwsId()
```
    The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
  - withCustomerAwsId
```
public EventSubscription withCustomerAwsId(String customerAwsId)
```
    The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    customerAwsId - The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustSubscriptionId
```
public void setCustSubscriptionId(String custSubscriptionId)
```
    The Amazon DocumentDB event notification subscription ID.
    
    Parameters:
    
    custSubscriptionId - The Amazon DocumentDB event notification subscription ID.
  - getCustSubscriptionId
```
public String getCustSubscriptionId()
```
    The Amazon DocumentDB event notification subscription ID.
    
    Returns:
    
    The Amazon DocumentDB event notification subscription ID.
  - withCustSubscriptionId
```
public EventSubscription withCustSubscriptionId(String custSubscriptionId)
```
    The Amazon DocumentDB event notification subscription ID.
    
    Parameters:
    
    custSubscriptionId - The Amazon DocumentDB event notification subscription ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnsTopicArn
```
public void setSnsTopicArn(String snsTopicArn)
```
    The topic ARN of the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    snsTopicArn - The topic ARN of the Amazon DocumentDB event notification subscription.
  - getSnsTopicArn
```
public String getSnsTopicArn()
```
    The topic ARN of the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The topic ARN of the Amazon DocumentDB event notification subscription.
  - withSnsTopicArn
```
public EventSubscription withSnsTopicArn(String snsTopicArn)
```
    The topic ARN of the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    snsTopicArn - The topic ARN of the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(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.
    
    Parameters:
    
    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.
  - getStatus
```
public String getStatus()
```
    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.
  - withStatus
```
public EventSubscription withStatus(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubscriptionCreationTime
```
public void setSubscriptionCreationTime(String subscriptionCreationTime)
```
    The time at which the Amazon DocumentDB event notification subscription was created.
    
    Parameters:
    
    subscriptionCreationTime - The time at which the Amazon DocumentDB event notification subscription was created.
  - getSubscriptionCreationTime
```
public String getSubscriptionCreationTime()
```
    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.
  - withSubscriptionCreationTime
```
public EventSubscription withSubscriptionCreationTime(String subscriptionCreationTime)
```
    The time at which the Amazon DocumentDB event notification subscription was created.
    
    Parameters:
    
    subscriptionCreationTime - The time at which the Amazon DocumentDB event notification subscription was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceType
```
public void setSourceType(String sourceType)
```
    The source type for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    sourceType - The source type for the Amazon DocumentDB event notification subscription.
  - getSourceType
```
public String getSourceType()
```
    The source type for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    The source type for the Amazon DocumentDB event notification subscription.
  - withSourceType
```
public EventSubscription withSourceType(String sourceType)
```
    The source type for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    sourceType - The source type for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSourceIdsList
```
public List<String> getSourceIdsList()
```
    A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    A list of source IDs for the Amazon DocumentDB event notification subscription.
  - setSourceIdsList
```
public void setSourceIdsList(Collection<String> sourceIdsList)
```
    A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.
  - withSourceIdsList
```
public EventSubscription withSourceIdsList(String... sourceIdsList)
```
    A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    NOTE: This method appends the values to the existing list (if any). Use setSourceIdsList(java.util.Collection) or withSourceIdsList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSourceIdsList
```
public EventSubscription withSourceIdsList(Collection<String> sourceIdsList)
```
    A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEventCategoriesList
```
public List<String> getEventCategoriesList()
```
    A list of event categories for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    A list of event categories for the Amazon DocumentDB event notification subscription.
  - setEventCategoriesList
```
public void setEventCategoriesList(Collection<String> eventCategoriesList)
```
    A list of event categories for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    eventCategoriesList - A list of event categories for the Amazon DocumentDB event notification subscription.
  - withEventCategoriesList
```
public EventSubscription withEventCategoriesList(String... eventCategoriesList)
```
    A list of event categories for the Amazon DocumentDB event notification subscription.
    
    NOTE: This method appends the values to the existing list (if any). Use setEventCategoriesList(java.util.Collection) or withEventCategoriesList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    eventCategoriesList - A list of event categories for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEventCategoriesList
```
public EventSubscription withEventCategoriesList(Collection<String> eventCategoriesList)
```
    A list of event categories for the Amazon DocumentDB event notification subscription.
    
    Parameters:
    
    eventCategoriesList - A list of event categories for the Amazon DocumentDB event notification subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
    
    Parameters:
    
    enabled - A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
  - getEnabled
```
public Boolean getEnabled()
```
    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.
  - withEnabled
```
public EventSubscription withEnabled(Boolean enabled)
```
    A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
    
    Parameters:
    
    enabled - A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    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.
  - setEventSubscriptionArn
```
public void setEventSubscriptionArn(String eventSubscriptionArn)
```
    The Amazon Resource Name (ARN) for the event subscription.
    
    Parameters:
    
    eventSubscriptionArn - The Amazon Resource Name (ARN) for the event subscription.
  - getEventSubscriptionArn
```
public String getEventSubscriptionArn()
```
    The Amazon Resource Name (ARN) for the event subscription.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the event subscription.
  - withEventSubscriptionArn
```
public EventSubscription withEventSubscriptionArn(String eventSubscriptionArn)
```
    The Amazon Resource Name (ARN) for the event subscription.
    
    Parameters:
    
    eventSubscriptionArn - The Amazon Resource Name (ARN) for the event subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 EventSubscription clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class EventSubscription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventSubscription

Method Detail

setCustomerAwsId

getCustomerAwsId

withCustomerAwsId

setCustSubscriptionId

getCustSubscriptionId

withCustSubscriptionId

setSnsTopicArn

getSnsTopicArn

withSnsTopicArn

setStatus

getStatus

withStatus

setSubscriptionCreationTime

getSubscriptionCreationTime

withSubscriptionCreationTime

setSourceType

getSourceType

withSourceType

getSourceIdsList

setSourceIdsList

withSourceIdsList

withSourceIdsList

getEventCategoriesList

setEventCategoriesList

withEventCategoriesList

withEventCategoriesList

setEnabled

getEnabled

withEnabled

isEnabled

setEventSubscriptionArn

getEventSubscriptionArn

withEventSubscriptionArn

toString

equals

hashCode

clone