TopicsDetectionJobProperties (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.TopicsDetectionJobProperties

All Implemented Interfaces:

java.io.Serializable
```
public class TopicsDetectionJobProperties
extends java.lang.Object
implements java.io.Serializable
```
Provides information about a topic detection job.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicsDetectionJobProperties()

Constructors
Constructor and Description
`TopicsDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
`java.util.Date`	`getEndTime()` The time that the topic detection job was completed.
`InputDataConfig`	`getInputDataConfig()` The input data configuration supplied when you created the topic detection job.
`java.lang.String`	`getJobId()` The identifier assigned to the topic detection job.
`java.lang.String`	`getJobName()` The name of the topic detection job.
`java.lang.String`	`getJobStatus()` The current status of the topic detection job.
`java.lang.String`	`getMessage()` A description for the status of a job.
`java.lang.Integer`	`getNumberOfTopics()` The number of topics to detect supplied when you created the topic detection job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration supplied when you created the topic detection job.
`java.util.Date`	`getSubmitTime()` The time that the topic detection job was submitted for processing.
`java.lang.String`	`getVolumeKmsKeyId()` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
`VpcConfig`	`getVpcConfig()` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.
`int`	`hashCode()`
`void`	`setDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
`void`	`setEndTime(java.util.Date endTime)` The time that the topic detection job was completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration supplied when you created the topic detection job.
`void`	`setJobId(java.lang.String jobId)` The identifier assigned to the topic detection job.
`void`	`setJobName(java.lang.String jobName)` The name of the topic detection job.
`void`	`setJobStatus(JobStatus jobStatus)` The current status of the topic detection job.
`void`	`setJobStatus(java.lang.String jobStatus)` The current status of the topic detection job.
`void`	`setMessage(java.lang.String message)` A description for the status of a job.
`void`	`setNumberOfTopics(java.lang.Integer numberOfTopics)` The number of topics to detect supplied when you created the topic detection job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration supplied when you created the topic detection job.
`void`	`setSubmitTime(java.util.Date submitTime)` The time that the topic detection job was submitted for processing.
`void`	`setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
`void`	`setVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TopicsDetectionJobProperties`	`withDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
`TopicsDetectionJobProperties`	`withEndTime(java.util.Date endTime)` The time that the topic detection job was completed.
`TopicsDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withJobId(java.lang.String jobId)` The identifier assigned to the topic detection job.
`TopicsDetectionJobProperties`	`withJobName(java.lang.String jobName)` The name of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(java.lang.String jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withMessage(java.lang.String message)` A description for the status of a job.
`TopicsDetectionJobProperties`	`withNumberOfTopics(java.lang.Integer numberOfTopics)` The number of topics to detect supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration supplied when you created the topic detection job.
`TopicsDetectionJobProperties`	`withSubmitTime(java.util.Date submitTime)` The time that the topic detection job was submitted for processing.
`TopicsDetectionJobProperties`	`withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
`TopicsDetectionJobProperties`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.

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

- Constructor Detail
  - TopicsDetectionJobProperties
```
public TopicsDetectionJobProperties()
```
- Method Detail
  - getJobId
```
public java.lang.String getJobId()
```
    The identifier assigned to the topic detection job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The identifier assigned to the topic detection job.
  - setJobId
```
public void setJobId(java.lang.String jobId)
```
    The identifier assigned to the topic detection job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobId -
    The identifier assigned to the topic detection job.
  - withJobId
```
public TopicsDetectionJobProperties withJobId(java.lang.String jobId)
```
    The identifier assigned to the topic detection job.
    
    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 assigned to the topic detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobName
```
public java.lang.String getJobName()
```
    The name of the topic detection job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The name of the topic detection job.
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    The name of the topic detection job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name of the topic detection job.
  - withJobName
```
public TopicsDetectionJobProperties withJobName(java.lang.String jobName)
```
    The name of the topic detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name of the topic detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobStatus
```
public java.lang.String getJobStatus()
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Returns:
    
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(java.lang.String jobStatus)
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TopicsDetectionJobProperties withJobStatus(java.lang.String jobStatus)
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    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 current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    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 current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TopicsDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    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 current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getMessage
```
public java.lang.String getMessage()
```
    A description for the status of a job.
    
    Returns:
    
    A description for the status of a job.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    A description for the status of a job.
    
    Parameters:
    
    message -
    A description for the status of a job.
  - withMessage
```
public TopicsDetectionJobProperties withMessage(java.lang.String message)
```
    A description for the status of a job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    message -
    A description for the status of a job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubmitTime
```
public java.util.Date getSubmitTime()
```
    The time that the topic detection job was submitted for processing.
    
    Returns:
    
    The time that the topic detection job was submitted for processing.
  - setSubmitTime
```
public void setSubmitTime(java.util.Date submitTime)
```
    The time that the topic detection job was submitted for processing.
    
    Parameters:
    
    submitTime -
    The time that the topic detection job was submitted for processing.
  - withSubmitTime
```
public TopicsDetectionJobProperties withSubmitTime(java.util.Date submitTime)
```
    The time that the topic detection job was submitted for processing.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    submitTime -
    The time that the topic detection job was submitted for processing.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public java.util.Date getEndTime()
```
    The time that the topic detection job was completed.
    
    Returns:
    
    The time that the topic detection job was completed.
  - setEndTime
```
public void setEndTime(java.util.Date endTime)
```
    The time that the topic detection job was completed.
    
    Parameters:
    
    endTime -
    The time that the topic detection job was completed.
  - withEndTime
```
public TopicsDetectionJobProperties withEndTime(java.util.Date endTime)
```
    The time that the topic detection job was completed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endTime -
    The time that the topic detection job was completed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration supplied when you created the topic detection job.
    
    Returns:
    
    The input data configuration supplied when you created the topic detection job.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration supplied when you created the topic detection job.
    
    Parameters:
    
    inputDataConfig -
    The input data configuration supplied when you created the topic detection job.
  - withInputDataConfig
```
public TopicsDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration supplied when you created the topic detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    The input data configuration supplied when you created the topic detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration supplied when you created the topic detection job.
    
    Returns:
    
    The output data configuration supplied when you created the topic detection job.
  - setOutputDataConfig
```
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration supplied when you created the topic detection job.
    
    Parameters:
    
    outputDataConfig -
    The output data configuration supplied when you created the topic detection job.
  - withOutputDataConfig
```
public TopicsDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration supplied when you created the topic detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    The output data configuration supplied when you created the topic detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNumberOfTopics
```
public java.lang.Integer getNumberOfTopics()
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Returns:
    
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
  - setNumberOfTopics
```
public void setNumberOfTopics(java.lang.Integer numberOfTopics)
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Parameters:
    
    numberOfTopics -
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
  - withNumberOfTopics
```
public TopicsDetectionJobProperties withNumberOfTopics(java.lang.Integer numberOfTopics)
```
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    numberOfTopics -
    The number of topics to detect supplied when you created the topic detection job. The default is 10.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDataAccessRoleArn
```
public java.lang.String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
  - withDataAccessRoleArn
```
public TopicsDetectionJobProperties withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVolumeKmsKeyId
```
public java.lang.String getVolumeKmsKeyId()
```
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Constraints:
    Length: - 2048
    Returns:
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
```
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Constraints:
    Length: - 2048
    Parameters:
    volumeKmsKeyId -
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - withVolumeKmsKeyId
```
public TopicsDetectionJobProperties withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
```
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2048
    Parameters:
    volumeKmsKeyId -
    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
    
    Returns:
    
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
  - setVpcConfig
```
public void setVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
    
    Parameters:
    
    vpcConfig -
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
  - withVpcConfig
```
public TopicsDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    vpcConfig -
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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

Class TopicsDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicsDetectionJobProperties

Method Detail

getJobId

setJobId

withJobId

getJobName

setJobName

withJobName

getJobStatus

setJobStatus

withJobStatus

setJobStatus

withJobStatus

getMessage

setMessage

withMessage

getSubmitTime

setSubmitTime

withSubmitTime

getEndTime

setEndTime

withEndTime

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getNumberOfTopics

setNumberOfTopics

withNumberOfTopics

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getVolumeKmsKeyId

setVolumeKmsKeyId

withVolumeKmsKeyId

getVpcConfig

setVpcConfig

withVpcConfig

toString

hashCode

equals