Package software.amazon.awssdk.services.docdb.model

Class CreateEventSubscriptionRequest

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.

  • Method Details

    • 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()
      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 DocDbRequest
      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.