software.amazon.awssdk.services.sqs.model

Class SendMessageBatchResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sqs.model.SQSResponse

software.amazon.awssdk.services.sqs.model.SendMessageBatchResponse

All Implemented Interfaces:

ToCopyableBuilder<SendMessageBatchResponse.Builder,SendMessageBatchResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class SendMessageBatchResponse
extends SQSResponse
implements ToCopyableBuilder<SendMessageBatchResponse.Builder,SendMessageBatchResponse>

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SendMessageBatchResponse.Builder

Method Summary

Modifier and Type	Method and Description
static SendMessageBatchResponse.Builder	builder()
boolean	equals(Object obj)
List<BatchResultErrorEntry>	failed() A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
static Class<? extends SendMessageBatchResponse.Builder>	serializableBuilderClass()
List<SendMessageBatchResultEntry>	successful() A list of SendMessageBatchResultEntry items.
SendMessageBatchResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

successful

public List<SendMessageBatchResultEntry> successful()

A list of SendMessageBatchResultEntry items.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of SendMessageBatchResultEntry items.

failed

public List<BatchResultErrorEntry> failed()

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

toBuilder

public SendMessageBatchResponse.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<SendMessageBatchResponse.Builder,SendMessageBatchResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static SendMessageBatchResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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