software.amazon.awssdk.services.comprehend.model

Interface PiiEntitiesDetectionJobProperties.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PiiEntitiesDetectionJobProperties.Builder,PiiEntitiesDetectionJobProperties>, SdkBuilder<PiiEntitiesDetectionJobProperties.Builder,PiiEntitiesDetectionJobProperties>, SdkPojo

Enclosing class:

PiiEntitiesDetectionJobProperties

public static interface PiiEntitiesDetectionJobProperties.Builder
extends SdkPojo, CopyableBuilder<PiiEntitiesDetectionJobProperties.Builder,PiiEntitiesDetectionJobProperties>

Method Summary

Modifier and Type	Method and Description
PiiEntitiesDetectionJobProperties.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
PiiEntitiesDetectionJobProperties.Builder	endTime(Instant endTime) The time that the PII entities detection job completed.
default PiiEntitiesDetectionJobProperties.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input properties for a PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input properties for a PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	jobArn(String jobArn) The Amazon Resource Name (ARN) of the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	jobId(String jobId) The identifier assigned to the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	jobName(String jobName) The name that you assigned the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	jobStatus(JobStatus jobStatus) The current status of the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	jobStatus(String jobStatus) The current status of the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	languageCode(LanguageCode languageCode) The language code of the input documents
PiiEntitiesDetectionJobProperties.Builder	languageCode(String languageCode) The language code of the input documents
PiiEntitiesDetectionJobProperties.Builder	message(String message) A description of the status of a job.
PiiEntitiesDetectionJobProperties.Builder	mode(PiiEntitiesDetectionMode mode) Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
PiiEntitiesDetectionJobProperties.Builder	mode(String mode) Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
default PiiEntitiesDetectionJobProperties.Builder	outputDataConfig(Consumer<PiiOutputDataConfig.Builder> outputDataConfig) The output data configuration that you supplied when you created the PII entities detection job.
PiiEntitiesDetectionJobProperties.Builder	outputDataConfig(PiiOutputDataConfig outputDataConfig) The output data configuration that you supplied when you created the PII entities detection job.
default PiiEntitiesDetectionJobProperties.Builder	redactionConfig(Consumer<RedactionConfig.Builder> redactionConfig) Provides configuration parameters for PII entity redaction.
PiiEntitiesDetectionJobProperties.Builder	redactionConfig(RedactionConfig redactionConfig) Provides configuration parameters for PII entity redaction.
PiiEntitiesDetectionJobProperties.Builder	submitTime(Instant submitTime) The time that the PII entities detection job was submitted for processing.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

jobId

PiiEntitiesDetectionJobProperties.Builder jobId(String jobId)

The identifier assigned to the PII entities detection job.

Parameters:

jobId - The identifier assigned to the PII entities detection job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobArn

PiiEntitiesDetectionJobProperties.Builder jobArn(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

jobName

PiiEntitiesDetectionJobProperties.Builder jobName(String jobName)

The name that you assigned the PII entities detection job.

Parameters:

jobName - The name that you assigned the PII entities detection job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobStatus

PiiEntitiesDetectionJobProperties.Builder jobStatus(String jobStatus)

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Parameters:

jobStatus - The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

jobStatus

PiiEntitiesDetectionJobProperties.Builder jobStatus(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.

Parameters:

jobStatus - The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

message

PiiEntitiesDetectionJobProperties.Builder message(String message)

A description of the status of a job.

Parameters:

message - A description of the status of a job.

Returns:

Returns a reference to this object so that method calls can be chained together.

submitTime

PiiEntitiesDetectionJobProperties.Builder submitTime(Instant submitTime)

The time that the PII entities detection job was submitted for processing.

Parameters:

submitTime - The time that the PII entities detection job was submitted for processing.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

PiiEntitiesDetectionJobProperties.Builder endTime(Instant endTime)

The time that the PII entities detection job completed.

Parameters:

endTime - The time that the PII entities detection job completed.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputDataConfig

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

inputDataConfig

default PiiEntitiesDetectionJobProperties.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

The input properties for a PII entities detection job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

Parameters:

inputDataConfig - a consumer that will call methods on InputDataConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

inputDataConfig(InputDataConfig)

outputDataConfig

PiiEntitiesDetectionJobProperties.Builder outputDataConfig(PiiOutputDataConfig outputDataConfig)

The output data configuration that you supplied when you created the PII entities detection job.

Parameters:

outputDataConfig - The output data configuration that you supplied when you created the PII entities detection job.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputDataConfig

default PiiEntitiesDetectionJobProperties.Builder outputDataConfig(Consumer<PiiOutputDataConfig.Builder> outputDataConfig)

The output data configuration that you supplied when you created the PII entities detection job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(PiiOutputDataConfig).

Parameters:

outputDataConfig - a consumer that will call methods on PiiOutputDataConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

outputDataConfig(PiiOutputDataConfig)

redactionConfig

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

redactionConfig

default PiiEntitiesDetectionJobProperties.Builder redactionConfig(Consumer<RedactionConfig.Builder> 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.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redactionConfig(RedactionConfig).

Parameters:

redactionConfig - a consumer that will call methods on RedactionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

redactionConfig(RedactionConfig)

languageCode

PiiEntitiesDetectionJobProperties.Builder languageCode(String languageCode)

The language code of the input documents

Parameters:

languageCode - The language code of the input documents

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageCode

PiiEntitiesDetectionJobProperties.Builder languageCode(LanguageCode languageCode)

The language code of the input documents

Parameters:

languageCode - The language code of the input documents

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

dataAccessRoleArn

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

mode

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

mode

PiiEntitiesDetectionJobProperties.Builder mode(PiiEntitiesDetectionMode 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