com.amazonaws.services.cloudsearchdomain.model

Class UploadDocumentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UploadDocumentsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UploadDocuments operation.

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 .

See Also:

AmazonCloudSearchDomain.uploadDocuments(UploadDocumentsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UploadDocumentsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UploadDocumentsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Long	getContentLength() Returns the value of the ContentLength property for this object.
String	getContentType() The format of the batch you are uploading.
InputStream	getDocuments() A batch of documents formatted in JSON or HTML.
int	hashCode()
void	setContentLength(Long contentLength) Sets the value of the ContentLength property for this object.
void	setContentType(ContentType contentType) The format of the batch you are uploading.
void	setContentType(String contentType) The format of the batch you are uploading.
void	setDocuments(InputStream documents) A batch of documents formatted in JSON or HTML.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UploadDocumentsRequest	withContentLength(Long contentLength) Sets the value of the ContentLength property for this object.
UploadDocumentsRequest	withContentType(ContentType contentType) The format of the batch you are uploading.
UploadDocumentsRequest	withContentType(String contentType) The format of the batch you are uploading.
UploadDocumentsRequest	withDocuments(InputStream documents) A batch of documents formatted in JSON or HTML.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UploadDocumentsRequest

public UploadDocumentsRequest()

Method Detail

getContentLength

public Long getContentLength()

Returns the value of the ContentLength property for this object.

Returns:

The value of the ContentLength property for this object.

setContentLength

public void setContentLength(Long contentLength)

Sets the value of the ContentLength property for this object.

Parameters:

contentLength - The new value for the ContentLength property for this object.

withContentLength

public UploadDocumentsRequest withContentLength(Long contentLength)

Sets the value of the ContentLength property for this object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

contentLength - The new value for the ContentLength property for this object.

Returns:

A reference to this updated object so that method calls can be chained together.

getDocuments

public InputStream getDocuments()

A batch of documents formatted in JSON or HTML. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Returns:

A batch of documents formatted in JSON or HTML.

setDocuments

public void setDocuments(InputStream documents)

A batch of documents formatted in JSON or HTML. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Parameters:

documents - A batch of documents formatted in JSON or HTML.

withDocuments

public UploadDocumentsRequest withDocuments(InputStream documents)

A batch of documents formatted in JSON or HTML. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Returns a reference to this object so that method calls can be chained together.

Parameters:

documents - A batch of documents formatted in JSON or HTML.

Returns:

A reference to this updated object so that method calls can be chained together.

getContentType

public String getContentType()

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

• application/json
• application/xml

Constraints:
Allowed Values: application/json, application/xml

Returns:

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

• application/json
• application/xml

See Also:

ContentType

setContentType

public void setContentType(String contentType)

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

• application/json
• application/xml

Constraints:
Allowed Values: application/json, application/xml

Parameters:

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

• application/json
• application/xml

See Also:

ContentType

withContentType

public UploadDocumentsRequest withContentType(String contentType)

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

• application/json
• application/xml

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: application/json, application/xml

Parameters:

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

• application/json
• application/xml

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ContentType

setContentType

public void setContentType(ContentType contentType)

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

• application/json
• application/xml

Constraints:
Allowed Values: application/json, application/xml

Parameters:

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

• application/json
• application/xml

See Also:

ContentType

withContentType

public UploadDocumentsRequest withContentType(ContentType contentType)

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

• application/json
• application/xml

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: application/json, application/xml

Parameters:

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

• application/json
• application/xml

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ContentType

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public UploadDocumentsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()