AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::BatchPutDocumentRequest Class Reference

#include <BatchPutDocumentRequest.h>

+ Inheritance diagram for Aws::kendra::Model::BatchPutDocumentRequest:

Public Member Functions

 BatchPutDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
BatchPutDocumentRequestWithIndexId (const Aws::String &value)
 
BatchPutDocumentRequestWithIndexId (Aws::String &&value)
 
BatchPutDocumentRequestWithIndexId (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
BatchPutDocumentRequestWithRoleArn (const Aws::String &value)
 
BatchPutDocumentRequestWithRoleArn (Aws::String &&value)
 
BatchPutDocumentRequestWithRoleArn (const char *value)
 
const Aws::Vector< Document > & GetDocuments () const
 
bool DocumentsHasBeenSet () const
 
void SetDocuments (const Aws::Vector< Document > &value)
 
void SetDocuments (Aws::Vector< Document > &&value)
 
BatchPutDocumentRequestWithDocuments (const Aws::Vector< Document > &value)
 
BatchPutDocumentRequestWithDocuments (Aws::Vector< Document > &&value)
 
BatchPutDocumentRequestAddDocuments (const Document &value)
 
BatchPutDocumentRequestAddDocuments (Document &&value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file BatchPutDocumentRequest.h.

Constructor & Destructor Documentation

◆ BatchPutDocumentRequest()

Aws::kendra::Model::BatchPutDocumentRequest::BatchPutDocumentRequest ( )

Member Function Documentation

◆ AddDocuments() [1/2]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::AddDocuments ( const Document value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 221 of file BatchPutDocumentRequest.h.

◆ AddDocuments() [2/2]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::AddDocuments ( Document &&  value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 231 of file BatchPutDocumentRequest.h.

◆ DocumentsHasBeenSet()

bool Aws::kendra::Model::BatchPutDocumentRequest::DocumentsHasBeenSet ( ) const
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 171 of file BatchPutDocumentRequest.h.

◆ GetDocuments()

const Aws::Vector<Document>& Aws::kendra::Model::BatchPutDocumentRequest::GetDocuments ( ) const
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 161 of file BatchPutDocumentRequest.h.

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::BatchPutDocumentRequest::GetIndexId ( ) const
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 43 of file BatchPutDocumentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::BatchPutDocumentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::BatchPutDocumentRequest::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 94 of file BatchPutDocumentRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::BatchPutDocumentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file BatchPutDocumentRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::BatchPutDocumentRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 49 of file BatchPutDocumentRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::kendra::Model::BatchPutDocumentRequest::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 102 of file BatchPutDocumentRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::BatchPutDocumentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocuments() [1/2]

void Aws::kendra::Model::BatchPutDocumentRequest::SetDocuments ( const Aws::Vector< Document > &  value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 181 of file BatchPutDocumentRequest.h.

◆ SetDocuments() [2/2]

void Aws::kendra::Model::BatchPutDocumentRequest::SetDocuments ( Aws::Vector< Document > &&  value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 191 of file BatchPutDocumentRequest.h.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetIndexId ( const Aws::String value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 55 of file BatchPutDocumentRequest.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 61 of file BatchPutDocumentRequest.h.

◆ SetIndexId() [3/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetIndexId ( const char *  value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 67 of file BatchPutDocumentRequest.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 110 of file BatchPutDocumentRequest.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 118 of file BatchPutDocumentRequest.h.

◆ SetRoleArn() [3/3]

void Aws::kendra::Model::BatchPutDocumentRequest::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 126 of file BatchPutDocumentRequest.h.

◆ WithDocuments() [1/2]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithDocuments ( const Aws::Vector< Document > &  value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 201 of file BatchPutDocumentRequest.h.

◆ WithDocuments() [2/2]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithDocuments ( Aws::Vector< Document > &&  value)
inline

One or more documents to add to the index.

Documents have the following file size limits.

  • 5 MB total size for inline documents

  • 50 MB total size for files from an S3 bucket

  • 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Definition at line 211 of file BatchPutDocumentRequest.h.

◆ WithIndexId() [1/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithIndexId ( const Aws::String value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 73 of file BatchPutDocumentRequest.h.

◆ WithIndexId() [2/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 79 of file BatchPutDocumentRequest.h.

◆ WithIndexId() [3/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithIndexId ( const char *  value)
inline

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Definition at line 85 of file BatchPutDocumentRequest.h.

◆ WithRoleArn() [1/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 134 of file BatchPutDocumentRequest.h.

◆ WithRoleArn() [2/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 142 of file BatchPutDocumentRequest.h.

◆ WithRoleArn() [3/3]

BatchPutDocumentRequest& Aws::kendra::Model::BatchPutDocumentRequest::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Definition at line 150 of file BatchPutDocumentRequest.h.


The documentation for this class was generated from the following file: