TopicsDetectionJobProperties (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TopicsDetectionJobProperties
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides information about a topic detection job.

See Also:: AWS API Documentation, 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
`TopicsDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`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.
`String`	`getJobId()` The identifier assigned to the topic detection job.
`String`	`getJobName()` The name of the topic detection job.
`String`	`getJobStatus()` The current status of the topic detection job.
`String`	`getMessage()` A description for the status of a job.
`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.
`Date`	`getSubmitTime()` The time that the topic detection job was submitted for processing.
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataAccessRoleArn(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(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(String jobId)` The identifier assigned to the topic detection job.
`void`	`setJobName(String jobName)` The name of the topic detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the topic detection job.
`void`	`setMessage(String message)` A description for the status of a job.
`void`	`setNumberOfTopics(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(Date submitTime)` The time that the topic detection job was submitted for processing.
`void`	`setVolumeKmsKeyId(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.
`String`	`toString()` Returns a string representation of this object.
`TopicsDetectionJobProperties`	`withDataAccessRoleArn(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(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(String jobId)` The identifier assigned to the topic detection job.
`TopicsDetectionJobProperties`	`withJobName(String jobName)` The name of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the topic detection job.
`TopicsDetectionJobProperties`	`withMessage(String message)` A description for the status of a job.
`TopicsDetectionJobProperties`	`withNumberOfTopics(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(Date submitTime)` The time that the topic detection job was submitted for processing.
`TopicsDetectionJobProperties`	`withVolumeKmsKeyId(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
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the topic detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the topic detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the topic detection job.
    
    Returns:
    
    The identifier assigned to the topic detection job.
  - withJobId
```
public TopicsDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the topic detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the topic detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the topic detection job.
    
    Parameters:
    
    jobName - The name of the topic detection job.
  - getJobName
```
public String getJobName()
```
    The name of the topic detection job.
    
    Returns:
    
    The name of the topic detection job.
  - withJobName
```
public TopicsDetectionJobProperties withJobName(String jobName)
```
    The name of the topic detection job.
    
    Parameters:
    
    jobName - The name of the topic detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(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.
    
    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
  - getJobStatus
```
public 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.
    
    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
  - withJobStatus
```
public TopicsDetectionJobProperties withJobStatus(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setMessage
```
public void setMessage(String message)
```
    A description for the status of a job.
    
    Parameters:
    
    message - A description for the status of a job.
  - getMessage
```
public String getMessage()
```
    A description for the status of a job.
    
    Returns:
    
    A description for the status of a job.
  - withMessage
```
public TopicsDetectionJobProperties withMessage(String message)
```
    A description for the status of a job.
    
    Parameters:
    
    message - A description for the status of a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubmitTime
```
public void setSubmitTime(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.
  - getSubmitTime
```
public 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.
  - withSubmitTime
```
public TopicsDetectionJobProperties withSubmitTime(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the topic detection job was completed.
    
    Parameters:
    
    endTime - The time that the topic detection job was completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the topic detection job was completed.
    
    Returns:
    
    The time that the topic detection job was completed.
  - withEndTime
```
public TopicsDetectionJobProperties withEndTime(Date endTime)
```
    The time that the topic detection job was completed.
    
    Parameters:
    
    endTime - The time that the topic detection job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withInputDataConfig
```
public TopicsDetectionJobProperties withInputDataConfig(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withOutputDataConfig
```
public TopicsDetectionJobProperties withOutputDataConfig(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfTopics
```
public void setNumberOfTopics(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.
  - getNumberOfTopics
```
public 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.
  - withNumberOfTopics
```
public TopicsDetectionJobProperties withNumberOfTopics(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(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.
    
    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.
  - getDataAccessRoleArn
```
public 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.
    
    Returns:
    
    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(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(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"
    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"
  - getVolumeKmsKeyId
```
public 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"
    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"
  - withVolumeKmsKeyId
```
public TopicsDetectionJobProperties withVolumeKmsKeyId(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"
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    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 TopicsDetectionJobProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TopicsDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicsDetectionJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setNumberOfTopics

getNumberOfTopics

withNumberOfTopics

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall