Class QueueConfiguration

java.lang.Object
software.amazon.awssdk.services.s3.model.QueueConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueueConfiguration.Builder,QueueConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class QueueConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueueConfiguration.Builder,QueueConfiguration>

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

See Also:

  • Method Details

    • id

      public final String id()
      Returns the value of the Id property for this object.
      Returns:
      The value of the Id property for this object.

    • queueArn

      public final String queueArn()

      The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

    • events

      public final List<Event> events()

      A collection of bucket events for which to send notifications

      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 hasEvents() method.

      Returns:
      A collection of bucket events for which to send notifications

    • hasEvents

      public final boolean hasEvents()
      For responses, this returns true if the service returned a value for the Events 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.

    • eventsAsStrings

      public final List<String> eventsAsStrings()

      A collection of bucket events for which to send notifications

      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 hasEvents() method.

      Returns:
      A collection of bucket events for which to send notifications

    • filter

      public final NotificationConfigurationFilter filter()
      Returns the value of the Filter property for this object.
      Returns:
      The value of the Filter property for this object.

    • toBuilder

      public QueueConfiguration.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<QueueConfiguration.Builder,QueueConfiguration>
      Returns:
      a builder for type T

    • builder

      public static QueueConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends QueueConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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