CreateEventSubscriptionRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.neptune.model.NeptuneRequest
    - - software.amazon.awssdk.services.neptune.model.CreateEventSubscriptionRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEventSubscriptionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEventSubscriptionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasEventCategories()` Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSourceIds()` Returns true if the SourceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 applied to the new event subscription.
`CreateEventSubscriptionRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
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 less than 255 characters.
    
    Returns:
    
    The name of the subscription.
    
    Constraints: The name must be less than 255 characters.
  - 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 a DB 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-snapshot | 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 a DB 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-snapshot | db-cluster-snapshot
  - hasEventCategories
```
public final boolean hasEventCategories()
```
    Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - eventCategories
```
public final List<String> eventCategories()
```
    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEventCategories() to see if a value was sent in this field.
    
    Returns:
    
    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
  - hasSourceIds
```
public final boolean hasSourceIds()
```
    Returns true if the SourceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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 supplied, SourceType must also be provided.
    - If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    - If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    - If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    - If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSourceIds() to see if a value was sent in this field.
    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 supplied, SourceType must also be provided.
    
    If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    
    If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    
    If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    
    If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
  - 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    The tags to be applied to the new event subscription.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags to be applied to the new event subscription.
  - toBuilder
```
public CreateEventSubscriptionRequest.Builder 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 interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
    
    Specified by:
    
    toBuilder in class NeptuneRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.59

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