com.amazonaws.services.comprehend.model

Class StartDocumentClassificationJobResult

java.lang.Object

com.amazonaws.services.comprehend.model.StartDocumentClassificationJobResult

All Implemented Interfaces:

java.io.Serializable

public class StartDocumentClassificationJobResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartDocumentClassificationJobResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() The identifier generated for the job.
java.lang.String	getJobStatus() The status of the job:
int	hashCode()
void	setJobId(java.lang.String jobId) The identifier generated for the job.
void	setJobStatus(JobStatus jobStatus) The status of the job:
void	setJobStatus(java.lang.String jobStatus) The status of the job:
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartDocumentClassificationJobResult	withJobId(java.lang.String jobId) The identifier generated for the job.
StartDocumentClassificationJobResult	withJobStatus(JobStatus jobStatus) The status of the job:
StartDocumentClassificationJobResult	withJobStatus(java.lang.String jobStatus) The status of the job:

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartDocumentClassificationJobResult

public StartDocumentClassificationJobResult()

Method Detail

getJobId

public java.lang.String getJobId()

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

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Returns:

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

setJobId

public void setJobId(java.lang.String jobId)

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

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobId -

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

withJobId

public StartDocumentClassificationJobResult withJobId(java.lang.String jobId)

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

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

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobId -

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

Returns:

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

getJobStatus

public java.lang.String getJobStatus()

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.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Returns:

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.

See Also:

JobStatus

setJobStatus

public void setJobStatus(java.lang.String jobStatus)

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.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Parameters:

jobStatus -

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.

See Also:

JobStatus

withJobStatus

public StartDocumentClassificationJobResult withJobStatus(java.lang.String jobStatus)

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.

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

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Parameters:

jobStatus -

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.

Returns:

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

See Also:

JobStatus

setJobStatus

public void setJobStatus(JobStatus jobStatus)

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.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Parameters:

jobStatus -

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.

See Also:

JobStatus

withJobStatus

public StartDocumentClassificationJobResult withJobStatus(JobStatus jobStatus)

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.

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

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Parameters:

jobStatus -

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.

Returns:

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

See Also:

JobStatus

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object