AWS SDK for C++  1.9.103
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::StartDocumentClassificationJobResult Class Reference

#include <StartDocumentClassificationJobResult.h>

Public Member Functions

 StartDocumentClassificationJobResult ()
 
 StartDocumentClassificationJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
StartDocumentClassificationJobResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetJobId () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
StartDocumentClassificationJobResultWithJobId (const Aws::String &value)
 
StartDocumentClassificationJobResultWithJobId (Aws::String &&value)
 
StartDocumentClassificationJobResultWithJobId (const char *value)
 
const Aws::StringGetJobArn () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
StartDocumentClassificationJobResultWithJobArn (const Aws::String &value)
 
StartDocumentClassificationJobResultWithJobArn (Aws::String &&value)
 
StartDocumentClassificationJobResultWithJobArn (const char *value)
 
const JobStatusGetJobStatus () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
StartDocumentClassificationJobResultWithJobStatus (const JobStatus &value)
 
StartDocumentClassificationJobResultWithJobStatus (JobStatus &&value)
 

Detailed Description

Definition at line 28 of file StartDocumentClassificationJobResult.h.

Constructor & Destructor Documentation

◆ StartDocumentClassificationJobResult() [1/2]

Aws::Comprehend::Model::StartDocumentClassificationJobResult::StartDocumentClassificationJobResult ( )

◆ StartDocumentClassificationJobResult() [2/2]

Aws::Comprehend::Model::StartDocumentClassificationJobResult::StartDocumentClassificationJobResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetJobArn()

const Aws::String& Aws::Comprehend::Model::StartDocumentClassificationJobResult::GetJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 88 of file StartDocumentClassificationJobResult.h.

◆ GetJobId()

const Aws::String& Aws::Comprehend::Model::StartDocumentClassificationJobResult::GetJobId ( ) const
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 40 of file StartDocumentClassificationJobResult.h.

◆ GetJobStatus()

const JobStatus& Aws::Comprehend::Model::StartDocumentClassificationJobResult::GetJobStatus ( ) const
inline

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Definition at line 167 of file StartDocumentClassificationJobResult.h.

◆ operator=()

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetJobArn() [1/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 110 of file StartDocumentClassificationJobResult.h.

◆ SetJobArn() [2/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 99 of file StartDocumentClassificationJobResult.h.

◆ SetJobArn() [3/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 121 of file StartDocumentClassificationJobResult.h.

◆ SetJobId() [1/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobId ( Aws::String &&  value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 52 of file StartDocumentClassificationJobResult.h.

◆ SetJobId() [2/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobId ( const Aws::String value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 46 of file StartDocumentClassificationJobResult.h.

◆ SetJobId() [3/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobId ( const char *  value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 58 of file StartDocumentClassificationJobResult.h.

◆ SetJobStatus() [1/2]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobStatus ( const JobStatus value)
inline

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Definition at line 179 of file StartDocumentClassificationJobResult.h.

◆ SetJobStatus() [2/2]

void Aws::Comprehend::Model::StartDocumentClassificationJobResult::SetJobStatus ( JobStatus &&  value)
inline

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Definition at line 191 of file StartDocumentClassificationJobResult.h.

◆ WithJobArn() [1/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 143 of file StartDocumentClassificationJobResult.h.

◆ WithJobArn() [2/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 132 of file StartDocumentClassificationJobResult.h.

◆ WithJobArn() [3/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 154 of file StartDocumentClassificationJobResult.h.

◆ WithJobId() [1/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobId ( Aws::String &&  value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 70 of file StartDocumentClassificationJobResult.h.

◆ WithJobId() [2/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobId ( const Aws::String value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 64 of file StartDocumentClassificationJobResult.h.

◆ WithJobId() [3/3]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobId ( const char *  value)
inline

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Definition at line 76 of file StartDocumentClassificationJobResult.h.

◆ WithJobStatus() [1/2]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobStatus ( const JobStatus value)
inline

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Definition at line 203 of file StartDocumentClassificationJobResult.h.

◆ WithJobStatus() [2/2]

StartDocumentClassificationJobResult& Aws::Comprehend::Model::StartDocumentClassificationJobResult::WithJobStatus ( JobStatus &&  value)
inline

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

Definition at line 215 of file StartDocumentClassificationJobResult.h.


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