@Generated(value="software.amazon.awssdk:codegen") public final class CreateEventSubscriptionRequest extends NeptuneRequest implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateEventSubscriptionRequest.Builder |
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.
|
overrideConfiguration
copy
public final String subscriptionName()
The name of the subscription.
Constraints: The name must be less than 255 characters.
Constraints: The name must be less than 255 characters.
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.
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
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
public final boolean hasEventCategories()
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.
public final boolean hasSourceIds()
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.
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.
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.
public final boolean hasTags()
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.
public CreateEventSubscriptionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
toBuilder
in class NeptuneRequest
public static CreateEventSubscriptionRequest.Builder builder()
public static Class<? extends CreateEventSubscriptionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.