com.amazonaws.services.bedrockruntime.model

Class DocumentSource

java.lang.Object

com.amazonaws.services.bedrockruntime.model.DocumentSource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentSource
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains the content of the document included in a message when sending a Converse or ConverseStream request or in the response.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentSource()

Method Summary

Modifier and Type	Method and Description
DocumentSource	clone()
boolean	equals(Object obj)
ByteBuffer	getBytes() A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setBytes(ByteBuffer bytes) A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.
String	toString() Returns a string representation of this object.
DocumentSource	withBytes(ByteBuffer bytes) A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentSource

public DocumentSource()

Method Detail

setBytes

public void setBytes(ByteBuffer bytes)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

bytes - A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

getBytes

public ByteBuffer getBytes()

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

withBytes

public DocumentSource withBytes(ByteBuffer bytes)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

bytes - A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentSource clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo