EntitiesDetectionJobProperties (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about an entities detection job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntitiesDetectionJobProperties()

Constructors
Constructor and Description
`EntitiesDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntitiesDetectionJobProperties`	`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 entities detection job completed
`String`	`getEntityRecognizerArn()` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`InputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the entities detection job.
`String`	`getJobId()` The identifier assigned to the entities detection job.
`String`	`getJobName()` The name that you assigned the entities detection job.
`String`	`getJobStatus()` The current status of the entities detection job.
`String`	`getLanguageCode()` The language code of the input documents.
`String`	`getMessage()` A description of the status of a job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration that you supplied when you created the entities detection job.
`Date`	`getSubmitTime()` The time that the entities 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 entity 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) that gives Amazon Comprehend read access to your input data.
`void`	`setEndTime(Date endTime)` The time that the entities detection job completed
`void`	`setEntityRecognizerArn(String entityRecognizerArn)` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the entities detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the entities detection job.
`void`	`setJobName(String jobName)` The name that you assigned the entities detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the entities 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)` The output data configuration that you supplied when you created the entities detection job.
`void`	`setSubmitTime(Date submitTime)` The time that the entities 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 entity detection job.
`String`	`toString()` Returns a string representation of this object.
`EntitiesDetectionJobProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`EntitiesDetectionJobProperties`	`withEndTime(Date endTime)` The time that the entities detection job completed
`EntitiesDetectionJobProperties`	`withEntityRecognizerArn(String entityRecognizerArn)` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`EntitiesDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the entities detection job.
`EntitiesDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the entities detection job.
`EntitiesDetectionJobProperties`	`withJobName(String jobName)` The name that you assigned the entities detection job.
`EntitiesDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the entities detection job.
`EntitiesDetectionJobProperties`	`withJobStatus(String jobStatus)` The current status of the entities detection job.
`EntitiesDetectionJobProperties`	`withLanguageCode(LanguageCode languageCode)` The language code of the input documents.
`EntitiesDetectionJobProperties`	`withLanguageCode(String languageCode)` The language code of the input documents.
`EntitiesDetectionJobProperties`	`withMessage(String message)` A description of the status of a job.
`EntitiesDetectionJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the entities detection job.
`EntitiesDetectionJobProperties`	`withSubmitTime(Date submitTime)` The time that the entities detection job was submitted for processing.
`EntitiesDetectionJobProperties`	`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.
`EntitiesDetectionJobProperties`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.

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

- Constructor Detail
  - EntitiesDetectionJobProperties
```
public EntitiesDetectionJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the entities detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the entities detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the entities detection job.
    
    Returns:
    
    The identifier assigned to the entities detection job.
  - withJobId
```
public EntitiesDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the entities detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the entities 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 that you assigned the entities detection job.
    
    Parameters:
    
    jobName - The name that you assigned the entities detection job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned the entities detection job.
    
    Returns:
    
    The name that you assigned the entities detection job.
  - withJobName
```
public EntitiesDetectionJobProperties withJobName(String jobName)
```
    The name that you assigned the entities detection job.
    
    Parameters:
    
    jobName - The name that you assigned the entities 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 entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the entities 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 entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public EntitiesDetectionJobProperties withJobStatus(String jobStatus)
```
    The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the entities 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 EntitiesDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the entities 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 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 EntitiesDetectionJobProperties 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 entities detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the entities detection job was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the entities detection job was submitted for processing.
    
    Returns:
    
    The time that the entities detection job was submitted for processing.
  - withSubmitTime
```
public EntitiesDetectionJobProperties withSubmitTime(Date submitTime)
```
    The time that the entities detection job was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the entities 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 entities detection job completed
    
    Parameters:
    
    endTime - The time that the entities detection job completed
  - getEndTime
```
public Date getEndTime()
```
    The time that the entities detection job completed
    
    Returns:
    
    The time that the entities detection job completed
  - withEndTime
```
public EntitiesDetectionJobProperties withEndTime(Date endTime)
```
    The time that the entities detection job completed
    
    Parameters:
    
    endTime - The time that the entities detection job completed
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEntityRecognizerArn
```
public void setEntityRecognizerArn(String entityRecognizerArn)
```
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    
    Parameters:
    
    entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
  - getEntityRecognizerArn
```
public String getEntityRecognizerArn()
```
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
  - withEntityRecognizerArn
```
public EntitiesDetectionJobProperties withEntityRecognizerArn(String entityRecognizerArn)
```
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    
    Parameters:
    
    entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
    
    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 entities detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the entities detection job.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration that you supplied when you created the entities detection job.
    
    Returns:
    
    The input data configuration that you supplied when you created the entities detection job.
  - withInputDataConfig
```
public EntitiesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the entities detection job.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the entities 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 entities detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the entities detection job.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration that you supplied when you created the entities detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created the entities detection job.
  - withOutputDataConfig
```
public EntitiesDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the entities detection job.
    
    Parameters:
    
    outputDataConfig - The output data configuration that you supplied when you created the entities detection job.
    
    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 EntitiesDetectionJobProperties 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 EntitiesDetectionJobProperties 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) 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 EntitiesDetectionJobProperties 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 EntitiesDetectionJobProperties 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 entity 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 entity 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 entity 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 entity detection job. For more information, see Amazon VPC.
  - withVpcConfig
```
public EntitiesDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity 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 entity 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 EntitiesDetectionJobProperties 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 EntitiesDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntitiesDetectionJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setEntityRecognizerArn

getEntityRecognizerArn

withEntityRecognizerArn

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall