com.amazonaws.services.comprehend.model

Class StartTargetedSentimentDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StartTargetedSentimentDetectionJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTargetedSentimentDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
StartTargetedSentimentDetectionJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique identifier for the request.
String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
InputDataConfig	getInputDataConfig()
String	getJobName() The identifier of the job.
String	getLanguageCode() The language of the input documents.
OutputDataConfig	getOutputDataConfig() Specifies where to send the output files.
List<Tag>	getTags() Tags to associate with the targeted sentiment detection job.
String	getVolumeKmsKeyId() ID for the 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()
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique identifier for the request.
void	setDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
void	setInputDataConfig(InputDataConfig inputDataConfig)
void	setJobName(String jobName) The identifier of the job.
void	setLanguageCode(String languageCode) The language of the input documents.
void	setOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
void	setTags(Collection<Tag> tags) Tags to associate with the targeted sentiment detection job.
void	setVolumeKmsKeyId(String volumeKmsKeyId) ID for the 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)
String	toString() Returns a string representation of this object.
StartTargetedSentimentDetectionJobRequest	withClientRequestToken(String clientRequestToken) A unique identifier for the request.
StartTargetedSentimentDetectionJobRequest	withDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
StartTargetedSentimentDetectionJobRequest	withInputDataConfig(InputDataConfig inputDataConfig)
StartTargetedSentimentDetectionJobRequest	withJobName(String jobName) The identifier of the job.
StartTargetedSentimentDetectionJobRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
StartTargetedSentimentDetectionJobRequest	withLanguageCode(String languageCode) The language of the input documents.
StartTargetedSentimentDetectionJobRequest	withOutputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
StartTargetedSentimentDetectionJobRequest	withTags(Collection<Tag> tags) Tags to associate with the targeted sentiment detection job.
StartTargetedSentimentDetectionJobRequest	withTags(Tag... tags) Tags to associate with the targeted sentiment detection job.
StartTargetedSentimentDetectionJobRequest	withVolumeKmsKeyId(String volumeKmsKeyId) ID for the 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.
StartTargetedSentimentDetectionJobRequest	withVpcConfig(VpcConfig vpcConfig)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartTargetedSentimentDetectionJobRequest

public StartTargetedSentimentDetectionJobRequest()

Method Detail

setInputDataConfig

public void setInputDataConfig(InputDataConfig inputDataConfig)

Parameters:

inputDataConfig -

getInputDataConfig

public InputDataConfig getInputDataConfig()

Returns:

withInputDataConfig

public StartTargetedSentimentDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig)

Parameters:

inputDataConfig -

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputDataConfig

public void setOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

getOutputDataConfig

public OutputDataConfig getOutputDataConfig()

Specifies where to send the output files.

Returns:

Specifies where to send the output files.

withOutputDataConfig

public StartTargetedSentimentDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

getDataAccessRoleArn

public String getDataAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Returns:

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

withDataAccessRoleArn

public StartTargetedSentimentDetectionJobRequest withDataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobName

public void setJobName(String jobName)

The identifier of the job.

Parameters:

jobName - The identifier of the job.

getJobName

public String getJobName()

The identifier of the job.

Returns:

The identifier of the job.

withJobName

public StartTargetedSentimentDetectionJobRequest withJobName(String jobName)

The identifier of the job.

Parameters:

jobName - The identifier of the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLanguageCode

public void setLanguageCode(String languageCode)

The language of the input documents. Currently, English is the only supported language.

Parameters:

languageCode - The language of the input documents. Currently, English is the only supported language.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language of the input documents. Currently, English is the only supported language.

Returns:

The language of the input documents. Currently, English is the only supported language.

See Also:

LanguageCode

withLanguageCode

public StartTargetedSentimentDetectionJobRequest withLanguageCode(String languageCode)

The language of the input documents. Currently, English is the only supported language.

Parameters:

languageCode - The language of the input documents. Currently, English is the only supported language.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

withLanguageCode

public StartTargetedSentimentDetectionJobRequest withLanguageCode(LanguageCode languageCode)

The language of the input documents. Currently, English is the only supported language.

Parameters:

languageCode - The language of the input documents. Currently, English is the only supported language.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Parameters:

clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

getClientRequestToken

public String getClientRequestToken()

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

withClientRequestToken

public StartTargetedSentimentDetectionJobRequest withClientRequestToken(String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Parameters:

clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVolumeKmsKeyId

public void setVolumeKmsKeyId(String volumeKmsKeyId)

ID for the 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 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 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 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 StartTargetedSentimentDetectionJobRequest withVolumeKmsKeyId(String volumeKmsKeyId)

ID for the 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 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)

Parameters:

vpcConfig -

getVpcConfig

public VpcConfig getVpcConfig()

Returns:

withVpcConfig

public StartTargetedSentimentDetectionJobRequest withVpcConfig(VpcConfig vpcConfig)

Parameters:

vpcConfig -

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

setTags

public void setTags(Collection<Tag> tags)

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

withTags

public StartTargetedSentimentDetectionJobRequest withTags(Tag... tags)

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public StartTargetedSentimentDetectionJobRequest withTags(Collection<Tag> tags)

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

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 StartTargetedSentimentDetectionJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()