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 a document.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentSource.Builder

static class DocumentSource.Type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentSource.Builder`	`builder()`
`SdkBytes`	`bytes()`	The raw bytes for the document.
`List<DocumentContentBlock>`	`content()`	The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
`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.
`static DocumentSource`	`fromContent(List<DocumentContentBlock> content)`	Create an instance of this class with `content()` initialized to the given value.
`static DocumentSource`	`fromS3Location(Consumer<S3Location.Builder> s3Location)`	Create an instance of this class with `s3Location()` initialized to the given value.
`static DocumentSource`	`fromS3Location(S3Location s3Location)`	Create an instance of this class with `s3Location()` initialized to the given value.
`static DocumentSource`	`fromText(String text)`	Create an instance of this class with `text()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContent()`	For responses, this returns true if the service returned a value for the Content property.
`int`	`hashCode()`
`S3Location`	`s3Location()`	The location of a document object in an Amazon S3 bucket.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentSource.Builder>`	`serializableBuilderClass()`
`String`	`text()`	The text content of the document source.
`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()
```
    The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
    
    Returns:
    
    The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
  - s3Location
```
public final S3Location s3Location()
```
    The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
    
    Returns:
    
    The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
  - text
```
public final String text()
```
    The text content of the document source.
    
    Returns:
    
    The text content of the document source.
  - hasContent
```
public final boolean hasContent()
```
    For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - content
```
public final List<DocumentContentBlock> content()
```
    The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContent() method.
    
    Returns:
    
    The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
  - 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.
    The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
    
    Parameters:
    
    bytes - The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
  - fromS3Location
```
public static DocumentSource fromS3Location(S3Location s3Location)
```
    Create an instance of this class with s3Location() initialized to the given value.
    The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
    
    Parameters:
    
    s3Location - The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
  - fromS3Location
```
public static DocumentSource fromS3Location(Consumer<S3Location.Builder> s3Location)
```
    Create an instance of this class with s3Location() initialized to the given value.
    The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
    
    Parameters:
    
    s3Location - The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.
  - fromText
```
public static DocumentSource fromText(String text)
```
    Create an instance of this class with text() initialized to the given value.
    The text content of the document source.
    
    Parameters:
    
    text - The text content of the document source.
  - fromContent
```
public static DocumentSource fromContent(List<DocumentContentBlock> content)
```
    Create an instance of this class with content() initialized to the given value.
    The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
    
    Parameters:
    
    content - The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

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

Class DocumentSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

bytes

s3Location

text

hasContent

content

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromBytes

fromS3Location

fromS3Location

fromText

fromContent

type

sdkFields

sdkFieldNameToField