java.lang.Object
- software.amazon.awssdk.services.comprehend.model.EntitiesDetectionJobProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>

@Generated("software.amazon.awssdk:codegen")
public final class EntitiesDetectionJobProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>

Provides information about an entities detection job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EntitiesDetectionJobProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EntitiesDetectionJobProperties.Builder`	`builder()`
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`Instant`	`endTime()`	The time that the entities detection job completed
`String`	`entityRecognizerArn()`	The Amazon Resource Name (ARN) that identifies the entity recognizer.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flywheelArn()`	The Amazon Resource Name (ARN) of the flywheel associated with this job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InputDataConfig`	`inputDataConfig()`	The input data configuration that you supplied when you created the entities detection job.
`String`	`jobArn()`	The Amazon Resource Name (ARN) of the entities detection job.
`String`	`jobId()`	The identifier assigned to the entities detection job.
`String`	`jobName()`	The name that you assigned the entities detection job.
`JobStatus`	`jobStatus()`	The current status of the entities detection job.
`String`	`jobStatusAsString()`	The current status of the entities detection job.
`LanguageCode`	`languageCode()`	The language code of the input documents.
`String`	`languageCodeAsString()`	The language code of the input documents.
`String`	`message()`	A description of the status of a job.
`OutputDataConfig`	`outputDataConfig()`	The output data configuration that you supplied when you created the entities detection job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EntitiesDetectionJobProperties.Builder>`	`serializableBuilderClass()`
`Instant`	`submitTime()`	The time that the entities detection job was submitted for processing.
`EntitiesDetectionJobProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`volumeKmsKeyId()`	ID for the Amazon Web Services 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`	`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobId
```
public final String jobId()
```
    The identifier assigned to the entities detection job.
    
    Returns:
    
    The identifier assigned to the entities detection job.
  - jobArn
```
public final String jobArn()
```
    The Amazon Resource Name (ARN) of the entities 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>:entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entities 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>:entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
  - jobName
```
public final String jobName()
```
    The name that you assigned the entities detection job.
    
    Returns:
    
    The name that you assigned the entities detection job.
  - jobStatus
```
public final JobStatus jobStatus()
```
    The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    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
  - jobStatusAsString
```
public final String jobStatusAsString()
```
    The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    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
  - message
```
public final String message()
```
    A description of the status of a job.
    
    Returns:
    
    A description of the status of a job.
  - submitTime
```
public final Instant submitTime()
```
    The time that the entities detection job was submitted for processing.
    
    Returns:
    
    The time that the entities detection job was submitted for processing.
  - endTime
```
public final Instant endTime()
```
    The time that the entities detection job completed
    
    Returns:
    
    The time that the entities detection job completed
  - entityRecognizerArn
```
public final String entityRecognizerArn()
```
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    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.
  - outputDataConfig
```
public final OutputDataConfig outputDataConfig()
```
    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.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code of the input documents.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code of the input documents.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    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.
  - volumeKmsKeyId
```
public final String volumeKmsKeyId()
```
    ID for the Amazon Web Services 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 Amazon Web Services 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"
  - vpcConfig
```
public final 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.
    
    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.
  - flywheelArn
```
public final String flywheelArn()
```
    The Amazon Resource Name (ARN) of the flywheel associated with this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the flywheel associated with this job.
  - toBuilder
```
public EntitiesDetectionJobProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>
  - builder
```
public static EntitiesDetectionJobProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EntitiesDetectionJobProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class EntitiesDetectionJobProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

jobArn

jobName

jobStatus

jobStatusAsString

message

submitTime

endTime

entityRecognizerArn

inputDataConfig

outputDataConfig

languageCode

languageCodeAsString

dataAccessRoleArn

volumeKmsKeyId

vpcConfig

flywheelArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields