Struct aws_sdk_cloudsearchdomain::operation::upload_documents::builders::UploadDocumentsFluentBuilder

pub struct UploadDocumentsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UploadDocuments.

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

Implementations

impl UploadDocumentsFluentBuilder

pub fn as_input(&self) -> &UploadDocumentsInputBuilder

Access the UploadDocuments as a reference.

pub async fn send( self ) -> Result<UploadDocumentsOutput, SdkError<UploadDocumentsError, 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<UploadDocumentsOutput, UploadDocumentsError, Self>

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

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

A batch of documents formatted in JSON or HTML.

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

A batch of documents formatted in JSON or HTML.

pub fn get_documents(&self) -> &Option<ByteStream>

A batch of documents formatted in JSON or HTML.

pub fn content_type(self, input: ContentType) -> Self

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json
• application/xml

pub fn set_content_type(self, input: Option<ContentType>) -> Self

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json
• application/xml

pub fn get_content_type(&self) -> &Option<ContentType>

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json
• application/xml

Trait Implementations

impl Debug for UploadDocumentsFluentBuilder

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

Formats the value using the given formatter.