Struct aws_sdk_comprehend::output::start_document_classification_job_output::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for StartDocumentClassificationJobOutput

Implementations

impl Builder

pub fn job_id(self, input: impl Into<String>) -> Self

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

pub fn set_job_id(self, input: Option<String>) -> Self

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

pub fn job_arn(self, input: impl Into<String>) -> Self

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::comprehend:::document-classification-job/

The following is an example job ARN:

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

pub fn set_job_arn(self, input: Option<String>) -> Self

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::comprehend:::document-classification-job/

The following is an example job ARN:

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

pub fn job_status(self, input: JobStatus) -> Self

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.

pub fn set_job_status(self, input: Option<JobStatus>) -> Self

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.

pub fn build(self) -> StartDocumentClassificationJobOutput

Consumes the builder and constructs a StartDocumentClassificationJobOutput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder