DominantLanguageDetectionJobProperties (AWS Java SDK for Amazon Comprehend 1.12.262 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a dominant language detection job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DominantLanguageDetectionJobProperties()

Constructors
Constructor and Description
`DominantLanguageDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DominantLanguageDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`Date`	`getEndTime()` The time that the dominant language detection job completed.
`InputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the dominant language detection job.
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the dominant language detection job.
`String`	`getJobId()` The identifier assigned to the dominant language detection job.
`String`	`getJobName()` The name that you assigned to the dominant language detection job.
`String`	`getJobStatus()` The current status of the dominant language detection job.
`String`	`getMessage()` A description for the status of a job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration that you supplied when you created the dominant language detection job.
`Date`	`getSubmitTime()` The time that the dominant language 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 dominant language detection job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`void`	`setEndTime(Date endTime)` The time that the dominant language detection job completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the dominant language detection job.
`void`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) of the dominant language detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the dominant language detection job.
`void`	`setJobName(String jobName)` The name that you assigned to the dominant language detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the dominant language detection job.
`void`	`setMessage(String message)` A description for the status of a job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the dominant language detection job.
`void`	`setSubmitTime(Date submitTime)` The time that the dominant language 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 dominant language detection job.
`String`	`toString()` Returns a string representation of this object.
`DominantLanguageDetectionJobProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`DominantLanguageDetectionJobProperties`	`withEndTime(Date endTime)` The time that the dominant language detection job completed.
`DominantLanguageDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) of the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withJobName(String jobName)` The name that you assigned to the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withMessage(String message)` A description for the status of a job.
`DominantLanguageDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the dominant language detection job.
`DominantLanguageDetectionJobProperties`	`withSubmitTime(Date submitTime)` The time that the dominant language detection job was submitted for processing.
`DominantLanguageDetectionJobProperties`	`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.
`DominantLanguageDetectionJobProperties`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job.

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

- Constructor Detail
  - DominantLanguageDetectionJobProperties
```
public DominantLanguageDetectionJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the dominant language detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the dominant language detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the dominant language detection job.
    
    Returns:
    
    The identifier assigned to the dominant language detection job.
  - withJobId
```
public DominantLanguageDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the dominant language detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the dominant language 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 dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
  - withJobArn
```
public DominantLanguageDetectionJobProperties withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:dominant-language-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 dominant language detection job.
    
    Parameters:
    
    jobName - The name that you assigned to the dominant language detection job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned to the dominant language detection job.
    
    Returns:
    
    The name that you assigned to the dominant language detection job.
  - withJobName
```
public DominantLanguageDetectionJobProperties withJobName(String jobName)
```
    The name that you assigned to the dominant language detection job.
    
    Parameters:
    
    jobName - The name that you assigned to the dominant language 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 dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public DominantLanguageDetectionJobProperties withJobStatus(String jobStatus)
```
    The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the dominant language detection job. If the status is FAILED, the Message 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 DominantLanguageDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the dominant language detection job. If the status is FAILED, the Message 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 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 DominantLanguageDetectionJobProperties 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 dominant language detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the dominant language detection job was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the dominant language detection job was submitted for processing.
    
    Returns:
    
    The time that the dominant language detection job was submitted for processing.
  - withSubmitTime
```
public DominantLanguageDetectionJobProperties withSubmitTime(Date submitTime)
```
    The time that the dominant language detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the dominant language 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 dominant language detection job completed.
    
    Parameters:
    
    endTime - The time that the dominant language detection job completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the dominant language detection job completed.
    
    Returns:
    
    The time that the dominant language detection job completed.
  - withEndTime
```
public DominantLanguageDetectionJobProperties withEndTime(Date endTime)
```
    The time that the dominant language detection job completed.
    
    Parameters:
    
    endTime - The time that the dominant language detection job 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 that you supplied when you created the dominant language detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the dominant language detection job.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration that you supplied when you created the dominant language detection job.
    
    Returns:
    
    The input data configuration that you supplied when you created the dominant language detection job.
  - withInputDataConfig
```
public DominantLanguageDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the dominant language detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the dominant language 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 that you supplied when you created the dominant language detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the dominant language detection job.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration that you supplied when you created the dominant language detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created the dominant language detection job.
  - withOutputDataConfig
```
public DominantLanguageDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the dominant language detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the dominant language detection job.
    
    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) that gives Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public DominantLanguageDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) that gives 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 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 DominantLanguageDetectionJobProperties 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 dominant language 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 dominant language 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 dominant language 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 dominant language detection job. For more information, see Amazon VPC.
  - withVpcConfig
```
public DominantLanguageDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language 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 dominant language 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 DominantLanguageDetectionJobProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class DominantLanguageDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DominantLanguageDetectionJobProperties

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

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall