Class PiiEntitiesDetectionJobProperties

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public PiiEntitiesDetectionJobProperties.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PiiEntitiesDetectionJobProperties.Builder,PiiEntitiesDetectionJobProperties>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.