EntityRecognizerProperties (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes information about an entity recognizer.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntityRecognizerProperties()

Constructors
Constructor and Description
`EntityRecognizerProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityRecognizerProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`Date`	`getEndTime()` The time that the recognizer creation completed.
`String`	`getEntityRecognizerArn()` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`EntityRecognizerInputDataConfig`	`getInputDataConfig()` The input data properties of an entity recognizer.
`String`	`getLanguageCode()` The language of the input documents.
`String`	`getMessage()` A description of the status of the recognizer.
`EntityRecognizerMetadata`	`getRecognizerMetadata()` Provides information about an entity recognizer.
`String`	`getStatus()` Provides the status of the entity recognizer.
`Date`	`getSubmitTime()` The time that the recognizer was submitted for processing.
`Date`	`getTrainingEndTime()` The time that training of the entity recognizer was completed.
`Date`	`getTrainingStartTime()` The time that training of the entity recognizer started.
`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 custom entity recognizer.
`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 AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`void`	`setEndTime(Date endTime)` The time that the recognizer creation completed.
`void`	`setEntityRecognizerArn(String entityRecognizerArn)` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`void`	`setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)` The input data properties of an entity recognizer.
`void`	`setLanguageCode(String languageCode)` The language of the input documents.
`void`	`setMessage(String message)` A description of the status of the recognizer.
`void`	`setRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)` Provides information about an entity recognizer.
`void`	`setStatus(String status)` Provides the status of the entity recognizer.
`void`	`setSubmitTime(Date submitTime)` The time that the recognizer was submitted for processing.
`void`	`setTrainingEndTime(Date trainingEndTime)` The time that training of the entity recognizer was completed.
`void`	`setTrainingStartTime(Date trainingStartTime)` The time that training of the entity recognizer started.
`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 custom entity recognizer.
`String`	`toString()` Returns a string representation of this object.
`EntityRecognizerProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`EntityRecognizerProperties`	`withEndTime(Date endTime)` The time that the recognizer creation completed.
`EntityRecognizerProperties`	`withEntityRecognizerArn(String entityRecognizerArn)` The Amazon Resource Name (ARN) that identifies the entity recognizer.
`EntityRecognizerProperties`	`withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)` The input data properties of an entity recognizer.
`EntityRecognizerProperties`	`withLanguageCode(LanguageCode languageCode)` The language of the input documents.
`EntityRecognizerProperties`	`withLanguageCode(String languageCode)` The language of the input documents.
`EntityRecognizerProperties`	`withMessage(String message)` A description of the status of the recognizer.
`EntityRecognizerProperties`	`withRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)` Provides information about an entity recognizer.
`EntityRecognizerProperties`	`withStatus(ModelStatus status)` Provides the status of the entity recognizer.
`EntityRecognizerProperties`	`withStatus(String status)` Provides the status of the entity recognizer.
`EntityRecognizerProperties`	`withSubmitTime(Date submitTime)` The time that the recognizer was submitted for processing.
`EntityRecognizerProperties`	`withTrainingEndTime(Date trainingEndTime)` The time that training of the entity recognizer was completed.
`EntityRecognizerProperties`	`withTrainingStartTime(Date trainingStartTime)` The time that training of the entity recognizer started.
`EntityRecognizerProperties`	`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.
`EntityRecognizerProperties`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.

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

- Constructor Detail
  - EntityRecognizerProperties
```
public EntityRecognizerProperties()
```
- Method Detail
  - 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 EntityRecognizerProperties 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.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Parameters:
    
    languageCode - The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Returns:
    
    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public EntityRecognizerProperties withLanguageCode(String languageCode)
```
    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Parameters:
    
    languageCode - The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public EntityRecognizerProperties withLanguageCode(LanguageCode languageCode)
```
    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Parameters:
    
    languageCode - The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setStatus
```
public void setStatus(String status)
```
    Provides the status of the entity recognizer.
    
    Parameters:
    
    status - Provides the status of the entity recognizer.
    
    See Also:
    
    ModelStatus
  - getStatus
```
public String getStatus()
```
    Provides the status of the entity recognizer.
    
    Returns:
    
    Provides the status of the entity recognizer.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public EntityRecognizerProperties withStatus(String status)
```
    Provides the status of the entity recognizer.
    
    Parameters:
    
    status - Provides the status of the entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public EntityRecognizerProperties withStatus(ModelStatus status)
```
    Provides the status of the entity recognizer.
    
    Parameters:
    
    status - Provides the status of the entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - setMessage
```
public void setMessage(String message)
```
    A description of the status of the recognizer.
    
    Parameters:
    
    message - A description of the status of the recognizer.
  - getMessage
```
public String getMessage()
```
    A description of the status of the recognizer.
    
    Returns:
    
    A description of the status of the recognizer.
  - withMessage
```
public EntityRecognizerProperties withMessage(String message)
```
    A description of the status of the recognizer.
    
    Parameters:
    
    message - A description of the status of the recognizer.
    
    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 recognizer was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the recognizer was submitted for processing.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the recognizer was submitted for processing.
    
    Returns:
    
    The time that the recognizer was submitted for processing.
  - withSubmitTime
```
public EntityRecognizerProperties withSubmitTime(Date submitTime)
```
    The time that the recognizer was submitted for processing.
    
    Parameters:
    
    submitTime - The time that the recognizer 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 recognizer creation completed.
    
    Parameters:
    
    endTime - The time that the recognizer creation completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the recognizer creation completed.
    
    Returns:
    
    The time that the recognizer creation completed.
  - withEndTime
```
public EntityRecognizerProperties withEndTime(Date endTime)
```
    The time that the recognizer creation completed.
    
    Parameters:
    
    endTime - The time that the recognizer creation completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingStartTime
```
public void setTrainingStartTime(Date trainingStartTime)
```
    The time that training of the entity recognizer started.
    
    Parameters:
    
    trainingStartTime - The time that training of the entity recognizer started.
  - getTrainingStartTime
```
public Date getTrainingStartTime()
```
    The time that training of the entity recognizer started.
    
    Returns:
    
    The time that training of the entity recognizer started.
  - withTrainingStartTime
```
public EntityRecognizerProperties withTrainingStartTime(Date trainingStartTime)
```
    The time that training of the entity recognizer started.
    
    Parameters:
    
    trainingStartTime - The time that training of the entity recognizer started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingEndTime
```
public void setTrainingEndTime(Date trainingEndTime)
```
    The time that training of the entity recognizer was completed.
    
    Parameters:
    
    trainingEndTime - The time that training of the entity recognizer was completed.
  - getTrainingEndTime
```
public Date getTrainingEndTime()
```
    The time that training of the entity recognizer was completed.
    
    Returns:
    
    The time that training of the entity recognizer was completed.
  - withTrainingEndTime
```
public EntityRecognizerProperties withTrainingEndTime(Date trainingEndTime)
```
    The time that training of the entity recognizer was completed.
    
    Parameters:
    
    trainingEndTime - The time that training of the entity recognizer was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputDataConfig
```
public void setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
```
    The input data properties of an entity recognizer.
    
    Parameters:
    
    inputDataConfig - The input data properties of an entity recognizer.
  - getInputDataConfig
```
public EntityRecognizerInputDataConfig getInputDataConfig()
```
    The input data properties of an entity recognizer.
    
    Returns:
    
    The input data properties of an entity recognizer.
  - withInputDataConfig
```
public EntityRecognizerProperties withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
```
    The input data properties of an entity recognizer.
    
    Parameters:
    
    inputDataConfig - The input data properties of an entity recognizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecognizerMetadata
```
public void setRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
```
    Provides information about an entity recognizer.
    
    Parameters:
    
    recognizerMetadata - Provides information about an entity recognizer.
  - getRecognizerMetadata
```
public EntityRecognizerMetadata getRecognizerMetadata()
```
    Provides information about an entity recognizer.
    
    Returns:
    
    Provides information about an entity recognizer.
  - withRecognizerMetadata
```
public EntityRecognizerProperties withRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
```
    Provides information about an entity recognizer.
    
    Parameters:
    
    recognizerMetadata - Provides information about an entity recognizer.
    
    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 AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public EntityRecognizerProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (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 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 EntityRecognizerProperties 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 custom entity recognizer. 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 custom entity recognizer. 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 custom entity recognizer. For more information, see Amazon VPC.
    
    Returns:
    
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
  - withVpcConfig
```
public EntityRecognizerProperties withVpcConfig(VpcConfig vpcConfig)
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. 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 custom entity recognizer. 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 EntityRecognizerProperties 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 EntityRecognizerProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityRecognizerProperties

Method Detail

setEntityRecognizerArn

getEntityRecognizerArn

withEntityRecognizerArn

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setStatus

getStatus

withStatus

withStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setTrainingStartTime

getTrainingStartTime

withTrainingStartTime

setTrainingEndTime

getTrainingEndTime

withTrainingEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setRecognizerMetadata

getRecognizerMetadata

withRecognizerMetadata

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall