Interface GetDocumentContentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>, QBusinessRequest.Builder, SdkBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDocumentContentRequest
@Mutable @NotThreadSafe public static interface GetDocumentContentRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<GetDocumentContentRequest.Builder,GetDocumentContentRequest>

  • Method Details

    • applicationId

      GetDocumentContentRequest.Builder applicationId(String applicationId)

      The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

      Parameters:
      applicationId - The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexId

      GetDocumentContentRequest.Builder indexId(String indexId)

      The identifier of the index where documents are indexed.

      Parameters:
      indexId - The identifier of the index where documents are indexed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceId

      GetDocumentContentRequest.Builder dataSourceId(String dataSourceId)

      The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".

      Parameters:
      dataSourceId - The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".
      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 that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

      Parameters:
      documentId - The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputFormat

      GetDocumentContentRequest.Builder outputFormat(String outputFormat)

      Document outputFormat. Defaults to RAW if not selected.

      Parameters:
      outputFormat - Document outputFormat. Defaults to RAW if not selected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputFormat

      GetDocumentContentRequest.Builder outputFormat(OutputFormat outputFormat)

      Document outputFormat. Defaults to RAW if not selected.

      Parameters:
      outputFormat - Document outputFormat. Defaults to RAW if not selected.
      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.