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

Interface StartPiiEntitiesDetectionJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>, SdkBuilder<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartPiiEntitiesDetectionJobRequest

public static interface StartPiiEntitiesDetectionJobRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<StartPiiEntitiesDetectionJobRequest.Builder,StartPiiEntitiesDetectionJobRequest>

Method Summary

Modifier and Type	Method	Description
StartPiiEntitiesDetectionJobRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for the request.
StartPiiEntitiesDetectionJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
default StartPiiEntitiesDetectionJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)	The input properties for a PII entities detection job.
StartPiiEntitiesDetectionJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig)	The input properties for a PII entities detection job.
StartPiiEntitiesDetectionJobRequest.Builder	jobName(String jobName)	The identifier of the job.
StartPiiEntitiesDetectionJobRequest.Builder	languageCode(String languageCode)	The language of the input documents.
StartPiiEntitiesDetectionJobRequest.Builder	languageCode(LanguageCode languageCode)	The language of the input documents.
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.
StartPiiEntitiesDetectionJobRequest.Builder	mode(PiiEntitiesDetectionMode mode)	Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
default StartPiiEntitiesDetectionJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)	Provides configuration parameters for the output of PII entity detection jobs.
StartPiiEntitiesDetectionJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Provides configuration parameters for the output of PII entity detection jobs.
StartPiiEntitiesDetectionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartPiiEntitiesDetectionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default StartPiiEntitiesDetectionJobRequest.Builder	redactionConfig(Consumer<RedactionConfig.Builder> redactionConfig)	Provides configuration parameters for PII entity redaction.
StartPiiEntitiesDetectionJobRequest.Builder	redactionConfig(RedactionConfig redactionConfig)	Provides configuration parameters for PII entity redaction.
StartPiiEntitiesDetectionJobRequest.Builder	tags(Collection<Tag> tags)	Tags to associate with the PII entities detection job.
StartPiiEntitiesDetectionJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Tags to associate with the PII entities detection job.
StartPiiEntitiesDetectionJobRequest.Builder	tags(Tag... tags)	Tags to associate with the PII entities detection job.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

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.

inputDataConfig

default StartPiiEntitiesDetectionJobRequest.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

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.

outputDataConfig

default StartPiiEntitiesDetectionJobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

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

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

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

Parameters:

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

Returns:

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

See Also:

• outputDataConfig(OutputDataConfig)

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

mode

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

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.

redactionConfig

default StartPiiEntitiesDetectionJobRequest.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)

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<Tag>).

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<Tag>)

overrideConfiguration

StartPiiEntitiesDetectionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartPiiEntitiesDetectionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.