StartTopicsDetectionJobRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.comprehend.model.StartTopicsDetectionJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartTopicsDetectionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartTopicsDetectionJobRequest()

Constructors
Constructor and Description
`StartTopicsDetectionJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientRequestToken()` A unique identifier for the request.
`java.lang.String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
`InputDataConfig`	`getInputDataConfig()` Specifies the format and location of the input data for the job.
`java.lang.String`	`getJobName()` The identifier of the job.
`java.lang.Integer`	`getNumberOfTopics()` The number of topics to detect.
`OutputDataConfig`	`getOutputDataConfig()` Specifies where to send the output files.
`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 an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.
`int`	`hashCode()`
`void`	`setClientRequestToken(java.lang.String clientRequestToken)` A unique identifier for the request.
`void`	`setDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` Specifies the format and location of the input data for the job.
`void`	`setJobName(java.lang.String jobName)` The identifier of the job.
`void`	`setNumberOfTopics(java.lang.Integer numberOfTopics)` The number of topics to detect.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` Specifies where to send the output files.
`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 an optional 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.
`StartTopicsDetectionJobRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` A unique identifier for the request.
`StartTopicsDetectionJobRequest`	`withDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
`StartTopicsDetectionJobRequest`	`withInputDataConfig(InputDataConfig inputDataConfig)` Specifies the format and location of the input data for the job.
`StartTopicsDetectionJobRequest`	`withJobName(java.lang.String jobName)` The identifier of the job.
`StartTopicsDetectionJobRequest`	`withNumberOfTopics(java.lang.Integer numberOfTopics)` The number of topics to detect.
`StartTopicsDetectionJobRequest`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` Specifies where to send the output files.
`StartTopicsDetectionJobRequest`	`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.
`StartTopicsDetectionJobRequest`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - StartTopicsDetectionJobRequest
```
public StartTopicsDetectionJobRequest()
```
- Method Detail
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    Specifies the format and location of the input data for the job.
    
    Returns:
    
    Specifies the format and location of the input data for the job.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig inputDataConfig)
```
    Specifies the format and location of the input data for the job.
    
    Parameters:
    
    inputDataConfig -
    Specifies the format and location of the input data for the job.
  - withInputDataConfig
```
public StartTopicsDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig)
```
    Specifies the format and location of the input data for the job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    Specifies the format and location of the input data for the job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
    
    Returns:
    
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
  - setOutputDataConfig
```
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
```
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
    
    Parameters:
    
    outputDataConfig -
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
  - withOutputDataConfig
```
public StartTopicsDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
    
    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 Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control- managing-permissions.html#auth-role-permissions.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access- control-managing-permissions.html#auth-role-permissions.
  - withDataAccessRoleArn
```
public StartTopicsDetectionJobRequest withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
    
    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 Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access- control-managing-permissions.html#auth-role-permissions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobName
```
public java.lang.String getJobName()
```
    The identifier of the job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The identifier of the job.
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    The identifier of the job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The identifier of the job.
  - withJobName
```
public StartTopicsDetectionJobRequest withJobName(java.lang.String jobName)
```
    The identifier of the 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 identifier of the 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.
    
    Constraints:
    Range: 1 - 100
    
    Returns:
    
    The number of topics to detect.
  - setNumberOfTopics
```
public void setNumberOfTopics(java.lang.Integer numberOfTopics)
```
    The number of topics to detect.
    
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    numberOfTopics -
    The number of topics to detect.
  - withNumberOfTopics
```
public StartTopicsDetectionJobRequest withNumberOfTopics(java.lang.Integer numberOfTopics)
```
    The number of topics to detect.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    numberOfTopics -
    The number of topics to detect.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientRequestToken
```
public java.lang.String getClientRequestToken()
```
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Returns:
    
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
  - setClientRequestToken
```
public void setClientRequestToken(java.lang.String clientRequestToken)
```
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Parameters:
    
    clientRequestToken -
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
  - withClientRequestToken
```
public StartTopicsDetectionJobRequest withClientRequestToken(java.lang.String clientRequestToken)
```
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Parameters:
    
    clientRequestToken -
    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
    
    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 StartTopicsDetectionJobRequest 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 an optional 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 an optional 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 an optional 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 an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
  - withVpcConfig
```
public StartTopicsDetectionJobRequest withVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for an optional 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 an optional 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 StartTopicsDetectionJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTopicsDetectionJobRequest

Method Detail

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getJobName

setJobName

withJobName

getNumberOfTopics

setNumberOfTopics

withNumberOfTopics

getClientRequestToken

setClientRequestToken

withClientRequestToken

getVolumeKmsKeyId

setVolumeKmsKeyId

withVolumeKmsKeyId

getVpcConfig

setVpcConfig

withVpcConfig

toString

hashCode

equals