Class StartPiiEntitiesDetectionJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.comprehend.model.ComprehendRequest
software.amazon.awssdk.services.comprehend.model.StartPiiEntitiesDetectionJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartPiiEntitiesDetectionJobRequest extends ComprehendRequest implements ToCopyableBuilder<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>

  • Method Details

    • 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 OutputDataConfig outputDataConfig()

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

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

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

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

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

    • jobName

      public final String jobName()

      The identifier of the job.

      Returns:
      The identifier of the job.

    • languageCode

      public final LanguageCode languageCode()

      The language of the input documents. Enter the language code for English (en) or Spanish (es).

      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 of the input documents. Enter the language code for English (en) or Spanish (es).
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language of the input documents. Enter the language code for English (en) or Spanish (es).

      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 of the input documents. Enter the language code for English (en) or Spanish (es).
      See Also:

    • clientRequestToken

      public final String clientRequestToken()

      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

      Returns:
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

    • toBuilder

      public StartPiiEntitiesDetectionJobRequest.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<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>
      Specified by:
      toBuilder in class ComprehendRequest
      Returns:
      a builder for type T

    • builder

      public static StartPiiEntitiesDetectionJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartPiiEntitiesDetectionJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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