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 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:

    • 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:

    • userContext

      GetDocumentContentRequest.Builder userContext(UserContext userContext)

      Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.

      Parameters:
      userContext - Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userContext

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

      Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.

      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:

    • 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.