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

Class StartPiiEntitiesDetectionJobRequest

    • Method Detail

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

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

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

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

      • 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