software.amazon.awssdk.core

Class ResponseBytes<ResponseT>

java.lang.Object

software.amazon.awssdk.core.ResponseBytes<ResponseT>

public final class ResponseBytes<ResponseT>
extends Object

An in-memory representation of the service's response from a streaming operation. This usually obtained by calling the "bytes" form of a streaming operation, like S3's getObjectBytes. Can also be retrieved by passing ResponseTransformer.toBytes() or AsyncResponseTransformer.toBytes() to a streaming output operation.

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray()
ByteBuffer	asByteBuffer()
InputStream	asInputStream()
String	asString(Charset charset) Retrieve the output as a string.
String	asUtf8String()
boolean	equals(Object o)
static <ResponseT> ResponseBytes<ResponseT>	fromByteArray(ResponseT response, byte[] bytes)
int	hashCode()
ResponseT	response()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

fromByteArray

public static <ResponseT> ResponseBytes<ResponseT> fromByteArray(ResponseT response,
                                                                 byte[] bytes)

response

public ResponseT response()

Returns:

the unmarshalled response object from the service.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

hashCode

public int hashCode()

asByteBuffer

public final ByteBuffer asByteBuffer()

Returns:

The output as a read-only byte buffer.

asByteArray

public final byte[] asByteArray()

Returns:

A copy of the output as a byte array.

See Also:

to prevent creating an additional array copy.

asString

public final String asString(Charset charset)
                      throws UncheckedIOException

Retrieve the output as a string.

Parameters:

charset - The charset of the string.

Returns:

The output as a string.

Throws:

UncheckedIOException - with a CharacterCodingException as the cause if the bytes cannot be encoded using the provided charset

asUtf8String

public final String asUtf8String()
                          throws UncheckedIOException

Returns:

The output as a utf-8 encoded string.

Throws:

UncheckedIOException - with a CharacterCodingException as the cause if the bytes cannot be encoded as UTF-8.

asInputStream

public final InputStream asInputStream()

Returns:

The output as an input stream. This stream will not need to be closed.