Struct aws_sdk_qbusiness::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder

pub struct BatchPutDocumentFluentBuilder { /* private fields */ }

Fluent builder constructing a request to BatchPutDocument.

Adds one or more documents to an Amazon Q index.

You use this API to:

• ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.

• add custom attributes to documents in an Amazon Q index.

• attach an access control list to the documents added to an Amazon Q index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Implementations

impl BatchPutDocumentFluentBuilder

pub fn as_input(&self) -> &BatchPutDocumentInputBuilder

Access the BatchPutDocument as a reference.

pub async fn send( self ) -> Result<BatchPutDocumentOutput, SdkError<BatchPutDocumentError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<BatchPutDocumentOutput, BatchPutDocumentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn application_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q application.

pub fn set_application_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q application.

pub fn get_application_id(&self) -> &Option<String>

The identifier of the Amazon Q application.

pub fn index_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q index to add the documents to.

pub fn set_index_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q index to add the documents to.

pub fn get_index_id(&self) -> &Option<String>

The identifier of the Amazon Q index to add the documents to.

pub fn documents(self, input: Document) -> Self

Appends an item to documents.

To override the contents of this collection use set_documents.

One or more documents to add to the index.

pub fn set_documents(self, input: Option<Vec<Document>>) -> Self

One or more documents to add to the index.

pub fn get_documents(&self) -> &Option<Vec<Document>>

One or more documents to add to the index.

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

pub fn data_source_sync_id(self, input: impl Into<String>) -> Self

The identifier of the data source sync during which the documents were added.

pub fn set_data_source_sync_id(self, input: Option<String>) -> Self

The identifier of the data source sync during which the documents were added.

pub fn get_data_source_sync_id(&self) -> &Option<String>

The identifier of the data source sync during which the documents were added.

Trait Implementations

impl Clone for BatchPutDocumentFluentBuilder

fn clone(&self) -> BatchPutDocumentFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchPutDocumentFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.