Package software.amazon.awssdk.services.comprehendmedical.model

Interface StartPhiDetectionJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendMedicalRequest.Builder, CopyableBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>, SdkBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartPhiDetectionJobRequest

public static interface StartPhiDetectionJobRequest.Builder
extends ComprehendMedicalRequest.Builder, SdkPojo, CopyableBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>

Method Summary

Modifier and Type	Method	Description
StartPhiDetectionJobRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for the request.
StartPhiDetectionJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
default StartPhiDetectionJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)	Specifies the format and location of the input data for the job.
StartPhiDetectionJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig)	Specifies the format and location of the input data for the job.
StartPhiDetectionJobRequest.Builder	jobName(String jobName)	The identifier of the job.
StartPhiDetectionJobRequest.Builder	kmsKey(String kmsKey)	An AWS Key Management Service key to encrypt your output files.
StartPhiDetectionJobRequest.Builder	languageCode(String languageCode)	The language of the input documents.
StartPhiDetectionJobRequest.Builder	languageCode(LanguageCode languageCode)	The language of the input documents.
default StartPhiDetectionJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)	Specifies where to send the output files.
StartPhiDetectionJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Specifies where to send the output files.
StartPhiDetectionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartPhiDetectionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalRequest.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

StartPhiDetectionJobRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig - Specifies the format and location of the input data for the job.

Returns:

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

inputDataConfig

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

Specifies the format and location of the input data for the 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

StartPhiDetectionJobRequest.Builder outputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

Returns:

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

outputDataConfig

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

Specifies where to send the output files.

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)

dataAccessRoleArn

StartPhiDetectionJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

Returns:

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

jobName

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

clientRequestToken

StartPhiDetectionJobRequest.Builder clientRequestToken(String clientRequestToken)

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

Parameters:

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

Returns:

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

kmsKey

StartPhiDetectionJobRequest.Builder kmsKey(String kmsKey)

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

Parameters:

kmsKey - An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

Returns:

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

languageCode

StartPhiDetectionJobRequest.Builder languageCode(String languageCode)

The language of the input documents. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. All documents must be in the same language.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

languageCode

StartPhiDetectionJobRequest.Builder languageCode(LanguageCode languageCode)

The language of the input documents. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. All documents must be in the same language.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

overrideConfiguration

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

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