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.CreateEventSubscriptionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

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

Represents the input to CreateEventSubscription.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateEventSubscriptionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateEventSubscriptionRequest.Builder`	`builder()`
`Boolean`	`enabled()`	A Boolean value; set to `true` to activate the subscription, set to `false` to create the subscription but not active it.
`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()`
`boolean`	`hasSourceIds()`	For responses, this returns true if the service returned a value for the SourceIds property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEventSubscriptionRequest.Builder>`	`serializableBuilderClass()`
`String`	`snsTopicArn()`	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
`List<String>`	`sourceIds()`	The list of identifiers of the event sources for which events are returned.
`String`	`sourceType()`	The type of source that is generating the events.
`String`	`subscriptionName()`	The name of the subscription.
`List<Tag>`	`tags()`	The tags to be assigned to the event subscription.
`CreateEventSubscriptionRequest.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 subscription.
    
    Constraints: The name must be fewer than 255 characters.
    
    Returns:
    
    The name of the subscription.
    
    Constraints: The name must be fewer than 255 characters.
  - snsTopicArn
```
public final String snsTopicArn()
```
    The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN 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, you would set this parameter to db-instance. If this value is not specified, all events are returned.
    
    Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
    
    Returns:
    
    The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
    
    Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
  - 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.
  - hasSourceIds
```
public final boolean hasSourceIds()
```
    For responses, this returns true if the service returned a value for the SourceIds 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.
  - sourceIds
```
public final List<String> sourceIds()
```
    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
    
    Constraints:
    
    If SourceIds are provided, SourceType must also be provided.
    
    If the source type is an instance, a DBInstanceIdentifier must be provided.
    
    If the source type is a security group, a DBSecurityGroupName must be provided.
    
    If the source type is a parameter group, a DBParameterGroupName must be provided.
    
    If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
    
    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 hasSourceIds() method.
    Returns:
    
    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
    
    Constraints:
    
    If SourceIds are provided, SourceType must also be provided.
    
    If the source type is an instance, a DBInstanceIdentifier must be provided.
    
    If the source type is a security group, a DBSecurityGroupName must be provided.
    
    If the source type is a parameter group, a DBParameterGroupName must be provided.
    
    If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
  - enabled
```
public final Boolean enabled()
```
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    
    Returns:
    
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The tags to be assigned to 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 hasTags() method.
    
    Returns:
    
    The tags to be assigned to the event subscription.
  - toBuilder
```
public CreateEventSubscriptionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
    
    Specified by:
    
    toBuilder in class DocDbRequest
  - builder
```
public static CreateEventSubscriptionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEventSubscriptionRequest.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

Class CreateEventSubscriptionRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

subscriptionName

snsTopicArn

sourceType

hasEventCategories

eventCategories

hasSourceIds

sourceIds

enabled

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields