Package org.opensearch.client.util

Class ByteArrayBinaryData

java.lang.Object

org.opensearch.client.util.ByteArrayBinaryData

All Implemented Interfaces:

JsonpSerializable, BinaryData

@JsonpDeserializable
public class ByteArrayBinaryData
extends Object
implements BinaryData

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ByteArrayBinaryData(byte[] bytes, int offset, int length, String contentType)
ByteArrayBinaryData(byte[] bytes, String contentType)
ByteArrayBinaryData(BinaryData data)	Copy another BinaryData.

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?
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ByteArrayBinaryData> _DESERIALIZER

Constructor Details

ByteArrayBinaryData

public ByteArrayBinaryData(byte[] bytes,
 int offset,
 int length,
 String contentType)

ByteArrayBinaryData

public ByteArrayBinaryData(byte[] bytes,
 String contentType)

ByteArrayBinaryData

public ByteArrayBinaryData(BinaryData data)
                    throws IOException

Copy another BinaryData. Typically used to make a replayable BinaryData from a non-replayable one.

Throws:

IOException

Method Details

contentType

public String contentType()

Get the content type of this binary data.

Specified by:

contentType in interface BinaryData

Returns:

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

writeTo

public void writeTo(OutputStream out)
             throws IOException

Write this data to an output stream.

Specified by:

writeTo in interface BinaryData

Throws:

IOException

size

public long size()

Get the estimated size in bytes of the data.

Specified by:

size in interface BinaryData

Returns:

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

asByteBuffer

public ByteBuffer asByteBuffer()

Return this data as a ByteBuffer.

Specified by:

asByteBuffer in interface BinaryData

asInputStream

public InputStream asInputStream()

Return this data as an InputStream.

Specified by:

asInputStream in interface BinaryData

isRepeatable

public boolean isRepeatable()

Can this object be consumed several times?

Specified by:

isRepeatable in interface BinaryData

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable