StartTopicsDetectionJobResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.comprehend.model

Class StartTopicsDetectionJobResult

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartTopicsDetectionJobResult ()

Constructors
Constructor and Description
`StartTopicsDetectionJobResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`StartTopicsDetectionJobResult`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getJobArn ()` The Amazon Resource Name (ARN) of the topics detection job.
`String`	`getJobId ()` The identifier generated for the job.
`String`	`getJobStatus ()` The status of the job:
`int`	`hashCode ()`
`void`	`setJobArn (String jobArn)` The Amazon Resource Name (ARN) of the topics detection 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.
`StartTopicsDetectionJobResult`	`withJobArn (String jobArn)` The Amazon Resource Name (ARN) of the topics detection job.
`StartTopicsDetectionJobResult`	`withJobId (String jobId)` The identifier generated for the job.
`StartTopicsDetectionJobResult`	`withJobStatus (JobStatus jobStatus)` The status of the job:
`StartTopicsDetectionJobResult`	`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
  - StartTopicsDetectionJobResult
```
public StartTopicsDetectionJobResult()
```
- 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 DescribeTopicDetectionJob operation.
    
    Parameters:
    
    jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
  - getJobId
```
public String getJobId()
```
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
    
    Returns:
    
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
  - withJobId
```
public StartTopicsDetectionJobResult withJobId(String jobId)
```
    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
    
    Parameters:
    
    jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob 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 topics detection 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>:topics-detection-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 topics detection 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>:topics-detection-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 topics detection 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>:topics-detection-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 topics detection 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>:topics-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
  - withJobArn
```
public StartTopicsDetectionJobResult withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the topics detection 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>:topics-detection-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 topics detection 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>:topics-detection-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 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 DescribeTopicDetectionJob operation.
    Parameters:
    jobStatus - 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 DescribeTopicDetectionJob operation.
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    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 DescribeTopicDetectionJob operation.
    Returns:
    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 DescribeTopicDetectionJob operation.
    See Also:
    
    JobStatus
  - withJobStatus
```
public StartTopicsDetectionJobResult withJobStatus(String jobStatus)
```
    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 DescribeTopicDetectionJob operation.
    Parameters:
    jobStatus - 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 DescribeTopicDetectionJob operation.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public StartTopicsDetectionJobResult withJobStatus(JobStatus jobStatus)
```
    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 DescribeTopicDetectionJob operation.
    Parameters:
    jobStatus - 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 DescribeTopicDetectionJob operation.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - 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 StartTopicsDetectionJobResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class StartTopicsDetectionJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

StartTopicsDetectionJobResult

Method Detail

setJobId

getJobId

withJobId

setJobArn

getJobArn

withJobArn

setJobStatus

getJobStatus

withJobStatus

withJobStatus

toString

equals

hashCode

clone