Package software.amazon.awssdk.services.comprehend.model

Class PiiOutputDataConfig

java.lang.Object
software.amazon.awssdk.services.comprehend.model.PiiOutputDataConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PiiOutputDataConfig.Builder,PiiOutputDataConfig>
@Generated("software.amazon.awssdk:codegen") public final class PiiOutputDataConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PiiOutputDataConfig.Builder,PiiOutputDataConfig>

Provides configuration parameters for the output of PII entity detection jobs.

See Also:

  • Method Details

    • s3Uri

      public final String s3Uri()

      When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      Returns:
      When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

    • kmsKeyId

      public final String kmsKeyId()

      ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

      Returns:
      ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

    • toBuilder

      public PiiOutputDataConfig.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<PiiOutputDataConfig.Builder,PiiOutputDataConfig>
      Returns:
      a builder for type T

    • builder

      public static PiiOutputDataConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PiiOutputDataConfig.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.