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

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

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

Provides information about a PII entities detection job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PiiEntitiesDetectionJobProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PiiEntitiesDetectionJobProperties.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 PII entities detection job completed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InputDataConfig`	`inputDataConfig()`	The input properties for a PII entities detection job.
`String`	`jobArn()`	The Amazon Resource Name (ARN) of the PII entities detection job.
`String`	`jobId()`	The identifier assigned to the PII entities detection job.
`String`	`jobName()`	The name that you assigned the PII entities detection job.
`JobStatus`	`jobStatus()`	The current status of the PII entities detection job.
`String`	`jobStatusAsString()`	The current status of the PII 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.
`PiiEntitiesDetectionMode`	`mode()`	Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`String`	`modeAsString()`	Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`PiiOutputDataConfig`	`outputDataConfig()`	The output data configuration that you supplied when you created the PII entities detection job.
`RedactionConfig`	`redactionConfig()`	Provides configuration parameters for PII entity redaction.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PiiEntitiesDetectionJobProperties.Builder>`	`serializableBuilderClass()`
`Instant`	`submitTime()`	The time that the PII entities detection job was submitted for processing.
`PiiEntitiesDetectionJobProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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 PII entities detection job.
    
    Returns:
    
    The identifier assigned to the PII entities detection job.
  - jobArn
```
public final String jobArn()
```
    The Amazon Resource Name (ARN) of the PII 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>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the PII 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>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
  - jobName
```
public final String jobName()
```
    The name that you assigned the PII entities detection job.
    
    Returns:
    
    The name that you assigned the PII entities detection job.
  - jobStatus
```
public final JobStatus jobStatus()
```
    The current status of the PII 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 PII 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 PII 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 PII 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 PII entities detection job was submitted for processing.
    
    Returns:
    
    The time that the PII entities detection job was submitted for processing.
  - endTime
```
public final Instant endTime()
```
    The time that the PII entities detection job completed.
    
    Returns:
    
    The time that the PII entities detection job completed.
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    The input properties for a PII entities detection job.
    
    Returns:
    
    The input properties for a PII entities detection job.
  - outputDataConfig
```
public final PiiOutputDataConfig outputDataConfig()
```
    The output data configuration that you supplied when you created the PII entities detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created the PII entities detection job.
  - redactionConfig
```
public final RedactionConfig redactionConfig()
```
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    
    Returns:
    
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
  - 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.
  - mode
```
public final PiiEntitiesDetectionMode mode()
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return PiiEntitiesDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - modeAsString
```
public final String modeAsString()
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return PiiEntitiesDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - toBuilder
```
public PiiEntitiesDetectionJobProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PiiEntitiesDetectionJobProperties.Builder,PiiEntitiesDetectionJobProperties>
  - builder
```
public static PiiEntitiesDetectionJobProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PiiEntitiesDetectionJobProperties.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 PiiEntitiesDetectionJobProperties

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

inputDataConfig

outputDataConfig

redactionConfig

languageCode

languageCodeAsString

dataAccessRoleArn

mode

modeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields