Package org.opensearch.client.util

Interface BinaryData

All Superinterfaces:

JsonpSerializable

All Known Implementing Classes:

ByteArrayBinaryData

@JsonpDeserializable
public interface BinaryData
extends JsonpSerializable

Binary data with an associated content type.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<BinaryData>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
ByteBuffer	asByteBuffer()	Return this data as a ByteBuffer.
InputStream	asInputStream()	Return this data as an InputStream.
String	contentType()	Get the content type of this binary data.
boolean	isRepeatable()	Can this object be consumed several times?
static BinaryData	of(byte[] value, int offset, int length, String contentType)
static BinaryData	of(byte[] bytes, String contentType)
static BinaryData	of(Object value, JsonpMapper mapper)	Create a BinaryData from a value and a JSON mapper.
long	size()	Get the estimated size in bytes of the data.
void	writeTo(OutputStream out)	Write this data to an output stream.

Methods inherited from interface org.opensearch.client.json.JsonpSerializable

serialize

Field Details

_DESERIALIZER

static final JsonpDeserializer<BinaryData> _DESERIALIZER

Method Details

contentType

String contentType()

Get the content type of this binary data.

Returns:

the content type (e.g., "application/json")

writeTo

void writeTo(OutputStream out)
      throws IOException

Write this data to an output stream.

Throws:

IllegalStateException - if the content has already been consumed and the object isn't replayable.

IOException

asByteBuffer

ByteBuffer asByteBuffer()
                 throws IOException

Return this data as a ByteBuffer.

Throws:

IllegalStateException - if the content has already been consumed and the object isn't replayable.

IOException

asInputStream

InputStream asInputStream()
                   throws IOException

Return this data as an InputStream.

Throws:

IllegalStateException - if the content has already been consumed and the object isn't replayable.

IOException

isRepeatable

boolean isRepeatable()

Can this object be consumed several times?

size

long size()

Get the estimated size in bytes of the data.

Returns:

the estimated size, or -1 if the value cannot be estimated or if the data has already been consumed.

of

static BinaryData of(Object value,
 JsonpMapper mapper)

Create a BinaryData from a value and a JSON mapper. The binary content is the result of serializing value with mapper. Returns null if value is null.

Note that the result's content-type can be different from "application/json" if the JSON mapper is setup to produce other representations such as CBOR or SMILE.

of

static BinaryData of(byte[] bytes,
 String contentType)

of

static BinaryData of(byte[] value,
 int offset,
 int length,
 String contentType)