Interface GetDocumentContentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>, SdkBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetDocumentContentRequest

@Mutable
@NotThreadSafe
public static interface GetDocumentContentRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>

Method Summary

Modifier and Type	Method	Description
GetDocumentContentRequest.Builder	dataSourceId(String dataSourceId)	The unique identifier of the data source that contains the document.
GetDocumentContentRequest.Builder	documentId(String documentId)	The unique identifier of the document to retrieve content for.
GetDocumentContentRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base that contains the document.
GetDocumentContentRequest.Builder	outputFormat(String outputFormat)	The output format for the document content.
GetDocumentContentRequest.Builder	outputFormat(DocumentOutputFormat outputFormat)	The output format for the document content.
GetDocumentContentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetDocumentContentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default GetDocumentContentRequest.Builder	userContext(Consumer<UserContext.Builder> userContext)	Sets the value of the UserContext property for this object.
GetDocumentContentRequest.Builder	userContext(UserContext userContext)	Sets the value of the UserContext property for this object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

dataSourceId

GetDocumentContentRequest.Builder dataSourceId(String dataSourceId)

The unique identifier of the data source that contains the document.

Parameters:

dataSourceId - The unique identifier of the data source that contains the document.

Returns:

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

documentId

GetDocumentContentRequest.Builder documentId(String documentId)

The unique identifier of the document to retrieve content for.

Parameters:

documentId - The unique identifier of the document to retrieve content for.

Returns:

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

knowledgeBaseId

GetDocumentContentRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that contains the document.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that contains the document.

Returns:

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

outputFormat

GetDocumentContentRequest.Builder outputFormat(String outputFormat)

The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.

Parameters:

outputFormat - The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.

Returns:

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

See Also:

• DocumentOutputFormat
• DocumentOutputFormat

outputFormat

GetDocumentContentRequest.Builder outputFormat(DocumentOutputFormat outputFormat)

The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.

Parameters:

outputFormat - The output format for the document content. RAW returns the original file. EXTRACTED returns parsed text as JSON. Defaults to RAW.

Returns:

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

See Also:

• DocumentOutputFormat
• DocumentOutputFormat

userContext

GetDocumentContentRequest.Builder userContext(UserContext userContext)

Sets the value of the UserContext property for this object.

Parameters:

userContext - The new value for the UserContext property for this object.

Returns:

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

userContext

default GetDocumentContentRequest.Builder userContext(Consumer<UserContext.Builder> userContext)

Sets the value of the UserContext property for this object. This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userContext(UserContext).

Parameters:

userContext - a consumer that will call methods on UserContext.Builder

Returns:

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

See Also:

• userContext(UserContext)

overrideConfiguration

GetDocumentContentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetDocumentContentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.