Package 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:
SdkPojo, ToCopyableBuilder<SendMessageBatchResponse.Builder,SendMessageBatchResponse>
@Generated("software.amazon.awssdk:codegen") public final 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.

  • Method Details

    • hasSuccessful

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

    • successful

      public final List<SendMessageBatchResultEntry> successful()

      A list of SendMessageBatchResultEntry items.

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

      Returns:
      A list of SendMessageBatchResultEntry items.

    • hasFailed

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

    • failed

      public final 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.

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

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

    • toBuilder

      public SendMessageBatchResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SendMessageBatchResponse.Builder,SendMessageBatchResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static SendMessageBatchResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • 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