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

Interface StartPiiEntitiesDetectionJobRequest.Builder

    • Method Detail

      • inputDataConfig

        StartPiiEntitiesDetectionJobRequest.Builder inputDataConfig​(InputDataConfig inputDataConfig)

        The input properties for a PII entities detection job.

        Parameters:
        inputDataConfig - The input properties for a PII entities detection job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputDataConfig

        StartPiiEntitiesDetectionJobRequest.Builder outputDataConfig​(OutputDataConfig outputDataConfig)

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

        Parameters:
        outputDataConfig - Provides configuration parameters for the output of PII entity detection jobs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mode

        StartPiiEntitiesDetectionJobRequest.Builder mode​(String mode)

        Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

        Parameters:
        mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PiiEntitiesDetectionMode, PiiEntitiesDetectionMode

      • redactionConfig

        StartPiiEntitiesDetectionJobRequest.Builder redactionConfig​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

        StartPiiEntitiesDetectionJobRequest.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

        Parameters:
        dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobName

        StartPiiEntitiesDetectionJobRequest.Builder jobName​(String jobName)

        The identifier of the job.

        Parameters:
        jobName - The identifier of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCode

        StartPiiEntitiesDetectionJobRequest.Builder languageCode​(String languageCode)

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

        Parameters:
        languageCode - The language of the input documents. Enter the language code for English (en) or Spanish (es).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • languageCode

        StartPiiEntitiesDetectionJobRequest.Builder languageCode​(LanguageCode languageCode)

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

        Parameters:
        languageCode - The language of the input documents. Enter the language code for English (en) or Spanish (es).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • clientRequestToken

        StartPiiEntitiesDetectionJobRequest.Builder clientRequestToken​(String clientRequestToken)

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

        Parameters:
        clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartPiiEntitiesDetectionJobRequest.Builder tags​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartPiiEntitiesDetectionJobRequest.Builder tags​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartPiiEntitiesDetectionJobRequest.Builder tags​(Consumer<Tag.Builder>... 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)