Package software.amazon.awssdk.services.s3.model

Class TopicConfiguration

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

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic 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.

    • topicArn

      public final String topicArn()

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

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

    • events

      public final List<Event> events()

      The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

      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:
      The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

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

      The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

      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:
      The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

    • 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 TopicConfiguration.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TopicConfiguration.Builder,TopicConfiguration>

    • builder

      public static TopicConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TopicConfiguration.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)
      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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo