Package software.amazon.awssdk.services.bedrockruntime.model

Class DocumentSource

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.DocumentSource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentSource.Builder,DocumentSource>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentSource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentSource.Builder,DocumentSource>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentSource.Builder
static class	DocumentSource.Type

Method Summary

Modifier and Type	Method	Description
static DocumentSource.Builder	builder()
SdkBytes	bytes()	A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static DocumentSource	fromBytes(SdkBytes bytes)	Create an instance of this class with bytes() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentSource.Builder>	serializableBuilderClass()
DocumentSource.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DocumentSource.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bytes

public final SdkBytes bytes()

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

Returns:

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

toBuilder

public DocumentSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentSource.Builder,DocumentSource>

builder

public static DocumentSource.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

fromBytes

public static DocumentSource fromBytes(SdkBytes bytes)

Create an instance of this class with bytes() initialized to the given value.

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

Parameters:

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

type

public DocumentSource.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be DocumentSource.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be DocumentSource.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo