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

#include <StartKeyPhrasesDetectionJobResult.h>

Public Member Functions

 StartKeyPhrasesDetectionJobResult ()
 
 StartKeyPhrasesDetectionJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
StartKeyPhrasesDetectionJobResultoperator= (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)
 
StartKeyPhrasesDetectionJobResultWithJobId (const Aws::String &value)
 
StartKeyPhrasesDetectionJobResultWithJobId (Aws::String &&value)
 
StartKeyPhrasesDetectionJobResultWithJobId (const char *value)
 
const Aws::StringGetJobArn () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
StartKeyPhrasesDetectionJobResultWithJobArn (const Aws::String &value)
 
StartKeyPhrasesDetectionJobResultWithJobArn (Aws::String &&value)
 
StartKeyPhrasesDetectionJobResultWithJobArn (const char *value)
 
const JobStatusGetJobStatus () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
StartKeyPhrasesDetectionJobResultWithJobStatus (const JobStatus &value)
 
StartKeyPhrasesDetectionJobResultWithJobStatus (JobStatus &&value)
 

Detailed Description

Definition at line 28 of file StartKeyPhrasesDetectionJobResult.h.

Constructor & Destructor Documentation

◆ StartKeyPhrasesDetectionJobResult() [1/2]

Aws::Comprehend::Model::StartKeyPhrasesDetectionJobResult::StartKeyPhrasesDetectionJobResult ( )

◆ StartKeyPhrasesDetectionJobResult() [2/2]

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

Member Function Documentation

◆ GetJobArn()

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 88 of file StartKeyPhrasesDetectionJobResult.h.

◆ GetJobId()

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

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

Definition at line 40 of file StartKeyPhrasesDetectionJobResult.h.

◆ GetJobStatus()

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

The status of the job.

  • SUBMITTED - The job has been received and is 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. To get details, use the operation.

Definition at line 164 of file StartKeyPhrasesDetectionJobResult.h.

◆ operator=()

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

◆ SetJobArn() [1/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 110 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobArn() [2/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 99 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobArn() [3/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 121 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobId() [1/3]

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

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

Definition at line 52 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobId() [2/3]

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

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

Definition at line 46 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobId() [3/3]

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

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

Definition at line 58 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobStatus() [1/2]

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

The status of the job.

  • SUBMITTED - The job has been received and is 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. To get details, use the operation.

Definition at line 173 of file StartKeyPhrasesDetectionJobResult.h.

◆ SetJobStatus() [2/2]

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

The status of the job.

  • SUBMITTED - The job has been received and is 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. To get details, use the operation.

Definition at line 182 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobArn() [1/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 143 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobArn() [2/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 132 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobArn() [3/3]

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

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 154 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobId() [1/3]

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

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

Definition at line 70 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobId() [2/3]

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

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

Definition at line 64 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobId() [3/3]

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

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

Definition at line 76 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobStatus() [1/2]

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

The status of the job.

  • SUBMITTED - The job has been received and is 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. To get details, use the operation.

Definition at line 191 of file StartKeyPhrasesDetectionJobResult.h.

◆ WithJobStatus() [2/2]

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

The status of the job.

  • SUBMITTED - The job has been received and is 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. To get details, use the operation.

Definition at line 200 of file StartKeyPhrasesDetectionJobResult.h.


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