TargetedSentimentDetectionJobProperties (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a targeted sentiment detection job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TargetedSentimentDetectionJobProperties()

Constructors
Constructor and Description
`TargetedSentimentDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetedSentimentDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`Date`	`getEndTime()` The time that the targeted sentiment detection job ended.
`InputDataConfig`	`getInputDataConfig()`
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the targeted sentiment detection job.
`String`	`getJobId()` The identifier assigned to the targeted sentiment detection job.
`String`	`getJobName()` The name that you assigned to the targeted sentiment detection job.
`String`	`getJobStatus()` The current status of the targeted sentiment detection job.
`String`	`getLanguageCode()` The language code of the input documents.
`String`	`getMessage()` A description of the status of a job.
`OutputDataConfig`	`getOutputDataConfig()`
`Date`	`getSubmitTime()` The time that the targeted sentiment detection job was submitted for processing.
`String`	`getVolumeKmsKeyId()` ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job.
`VpcConfig`	`getVpcConfig()`
`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 IAM role that grants Amazon Comprehend read access to your input data.
`void`	`setEndTime(Date endTime)` The time that the targeted sentiment detection job ended.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)`
`void`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) of the targeted sentiment detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the targeted sentiment detection job.
`void`	`setJobName(String jobName)` The name that you assigned to the targeted sentiment detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the targeted sentiment detection job.
`void`	`setLanguageCode(String languageCode)` The language code of the input documents.
`void`	`setMessage(String message)` A description of the status of a job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)`
`void`	`setSubmitTime(Date submitTime)` The time that the targeted sentiment detection job was submitted for processing.
`void`	`setVolumeKmsKeyId(String volumeKmsKeyId)` ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job.
`void`	`setVpcConfig(VpcConfig vpcConfig)`
`String`	`toString()` Returns a string representation of this object.
`TargetedSentimentDetectionJobProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`TargetedSentimentDetectionJobProperties`	`withEndTime(Date endTime)` The time that the targeted sentiment detection job ended.
`TargetedSentimentDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)`
`TargetedSentimentDetectionJobProperties`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) of the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withJobName(String jobName)` The name that you assigned to the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withLanguageCode(LanguageCode languageCode)` The language code of the input documents.
`TargetedSentimentDetectionJobProperties`	`withLanguageCode(String languageCode)` The language code of the input documents.
`TargetedSentimentDetectionJobProperties`	`withMessage(String message)` A description of the status of a job.
`TargetedSentimentDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)`
`TargetedSentimentDetectionJobProperties`	`withSubmitTime(Date submitTime)` The time that the targeted sentiment detection job was submitted for processing.
`TargetedSentimentDetectionJobProperties`	`withVolumeKmsKeyId(String volumeKmsKeyId)` ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job.
`TargetedSentimentDetectionJobProperties`	`withVpcConfig(VpcConfig vpcConfig)`

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

- Constructor Detail
  - TargetedSentimentDetectionJobProperties
```
public TargetedSentimentDetectionJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the targeted sentiment detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the targeted sentiment detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the targeted sentiment detection job.
    
    Returns:
    
    The identifier assigned to the targeted sentiment detection job.
  - withJobId
```
public TargetedSentimentDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the targeted sentiment detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the targeted sentiment detection job.
    
    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 targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
  - withJobArn
```
public TargetedSentimentDetectionJobProperties withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name that you assigned to the targeted sentiment detection job.
    
    Parameters:
    
    jobName - The name that you assigned to the targeted sentiment detection job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned to the targeted sentiment detection job.
    
    Returns:
    
    The name that you assigned to the targeted sentiment detection job.
  - withJobName
```
public TargetedSentimentDetectionJobProperties withJobName(String jobName)
```
    The name that you assigned to the targeted sentiment detection job.
    
    Parameters:
    
    jobName - The name that you assigned to the targeted sentiment 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 targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    Returns:
    
    The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TargetedSentimentDetectionJobProperties withJobStatus(String jobStatus)
```
    The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public TargetedSentimentDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
    
    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 of the status of a job.
    
    Parameters:
    
    message - A description of the status of a job.
  - getMessage
```
public String getMessage()
```
    A description of the status of a job.
    
    Returns:
    
    A description of the status of a job.
  - withMessage
```
public TargetedSentimentDetectionJobProperties withMessage(String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message - A description of 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 targeted sentiment detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the targeted sentiment detection job was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the targeted sentiment detection job was submitted for processing.
    
    Returns:
    
    The time that the targeted sentiment detection job was submitted for processing.
  - withSubmitTime
```
public TargetedSentimentDetectionJobProperties withSubmitTime(Date submitTime)
```
    The time that the targeted sentiment detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the targeted sentiment 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 targeted sentiment detection job ended.
    
    Parameters:
    
    endTime - The time that the targeted sentiment detection job ended.
  - getEndTime
```
public Date getEndTime()
```
    The time that the targeted sentiment detection job ended.
    
    Returns:
    
    The time that the targeted sentiment detection job ended.
  - withEndTime
```
public TargetedSentimentDetectionJobProperties withEndTime(Date endTime)
```
    The time that the targeted sentiment detection job ended.
    
    Parameters:
    
    endTime - The time that the targeted sentiment detection job ended.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig inputDataConfig)
```
    Parameters:
    
    inputDataConfig -
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    Returns:
  - withInputDataConfig
```
public TargetedSentimentDetectionJobProperties 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)
```
    Parameters:
    
    outputDataConfig -
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    Returns:
  - withOutputDataConfig
```
public TargetedSentimentDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    Parameters:
    
    outputDataConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code of the input documents.
    
    Returns:
    
    The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TargetedSentimentDetectionJobProperties withLanguageCode(String languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TargetedSentimentDetectionJobProperties withLanguageCode(LanguageCode languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - 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.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public TargetedSentimentDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input 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 KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 TargetedSentimentDetectionJobProperties withVolumeKmsKeyId(String volumeKmsKeyId)
```
    ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 TargetedSentimentDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
```
    Parameters:
    
    vpcConfig -
    
    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 TargetedSentimentDetectionJobProperties 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class TargetedSentimentDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetedSentimentDetectionJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobArn

getJobArn

withJobArn

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall