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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueueConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static QueueConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Event>	events()	A collection of bucket events for which to send notifications
List<String>	eventsAsStrings()	A collection of bucket events for which to send notifications
NotificationConfigurationFilter	filter()	Returns the value of the Filter property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvents()	For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
String	id()	Returns the value of the Id property for this object.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends QueueConfiguration.Builder>	serializableBuilderClass()
QueueConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<QueueConfiguration.Builder,QueueConfiguration>

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)

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