Interface GetDocumentContentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetDocumentContentRequest.Builder,
,GetDocumentContentRequest> QBusinessRequest.Builder
,SdkBuilder<GetDocumentContentRequest.Builder,
,GetDocumentContentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetDocumentContentRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The unique identifier of the Amazon Q Business application containing the document.dataSourceId
(String dataSourceId) The identifier of the data source from which the document was ingested.documentId
(String documentId) The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync.The identifier of the index where documents are indexed.outputFormat
(String outputFormat) Raw document outputFormat.outputFormat
(OutputFormat outputFormat) Raw document outputFormat.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessRequest.Builder
build
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
-
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
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
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
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
Raw document outputFormat.
- Parameters:
outputFormat
- Raw document outputFormat.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputFormat
Raw document outputFormat.
- Parameters:
outputFormat
- Raw document outputFormat.- 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-