StartDocumentClassificationJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.comprehend.model.StartDocumentClassificationJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartDocumentClassificationJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartDocumentClassificationJobResult()

Constructors
Constructor and Description
`StartDocumentClassificationJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartDocumentClassificationJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentClassifierArn()` The ARN of the custom classification model.
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the document classification job.
`String`	`getJobId()` The identifier generated for the job.
`String`	`getJobStatus()` The status of the job:
`int`	`hashCode()`
`void`	`setDocumentClassifierArn(String documentClassifierArn)` The ARN of the custom classification model.
`void`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) of the document classification job.
`void`	`setJobId(String jobId)` The identifier generated for the job.
`void`	`setJobStatus(String jobStatus)` The status of the job:
`String`	`toString()` Returns a string representation of this object.
`StartDocumentClassificationJobResult`	`withDocumentClassifierArn(String documentClassifierArn)` The ARN of the custom classification model.
`StartDocumentClassificationJobResult`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) of the document classification job.
`StartDocumentClassificationJobResult`	`withJobId(String jobId)` The identifier generated for the job.
`StartDocumentClassificationJobResult`	`withJobStatus(JobStatus jobStatus)` The status of the job:
`StartDocumentClassificationJobResult`	`withJobStatus(String jobStatus)` The status of the job:

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartDocumentClassificationJobResult
```
public StartDocumentClassificationJobResult()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
    
    Parameters:
    
    jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
  - getJobId
```
public String getJobId()
```
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
    
    Returns:
    
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
  - withJobId
```
public StartDocumentClassificationJobResult withJobId(String jobId)
```
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
    
    Parameters:
    
    jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobArn
```
public void setJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
    
    Returns:
    
    The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
  - withJobArn
```
public StartDocumentClassificationJobResult withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(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 DescribeDocumentClassificationJob 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.
    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 DescribeDocumentClassificationJob 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
  - getJobStatus
```
public 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 DescribeDocumentClassificationJob 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:
    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 DescribeDocumentClassificationJob 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(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 DescribeDocumentClassificationJob 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.
    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 DescribeDocumentClassificationJob 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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 DescribeDocumentClassificationJob 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.
    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 DescribeDocumentClassificationJob 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setDocumentClassifierArn
```
public void setDocumentClassifierArn(String documentClassifierArn)
```
    The ARN of the custom classification model.
    
    Parameters:
    
    documentClassifierArn - The ARN of the custom classification model.
  - getDocumentClassifierArn
```
public String getDocumentClassifierArn()
```
    The ARN of the custom classification model.
    
    Returns:
    
    The ARN of the custom classification model.
  - withDocumentClassifierArn
```
public StartDocumentClassificationJobResult withDocumentClassifierArn(String documentClassifierArn)
```
    The ARN of the custom classification model.
    
    Parameters:
    
    documentClassifierArn - The ARN of the custom classification model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StartDocumentClassificationJobResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.792

Class StartDocumentClassificationJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

StartDocumentClassificationJobResult

Method Detail

setJobId

getJobId

withJobId

setJobArn

getJobArn

withJobArn

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setDocumentClassifierArn

getDocumentClassifierArn

withDocumentClassifierArn

toString

equals

hashCode

clone