Interface StartDataTransformationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>, HealthLakeRequest.Builder, SdkBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartDataTransformationJobRequest

@Mutable
@NotThreadSafe
public static interface StartDataTransformationJobRequest.Builder
extends HealthLakeRequest.Builder, SdkPojo, CopyableBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>

Method Summary

Modifier and Type	Method	Description
StartDataTransformationJobRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the operation completes no more than one time.
StartDataTransformationJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.
StartDataTransformationJobRequest.Builder	driftDetectionEnabled(Boolean driftDetectionEnabled)	Specifies whether drift detection is enabled for this job.
default StartDataTransformationJobRequest.Builder	inputDataConfig(Consumer<TransformationInputDataConfig.Builder> inputDataConfig)	The Amazon S3 location and format of the source files to transform.
StartDataTransformationJobRequest.Builder	inputDataConfig(TransformationInputDataConfig inputDataConfig)	The Amazon S3 location and format of the source files to transform.
StartDataTransformationJobRequest.Builder	jobName(String jobName)	A descriptive name for the data transformation job.
default StartDataTransformationJobRequest.Builder	outputDataConfig(Consumer<TransformationOutputDataConfig.Builder> outputDataConfig)	The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
StartDataTransformationJobRequest.Builder	outputDataConfig(TransformationOutputDataConfig outputDataConfig)	The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
StartDataTransformationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartDataTransformationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartDataTransformationJobRequest.Builder	profileId(String profileId)	The unique identifier of the data transformation profile to use for conversion.
StartDataTransformationJobRequest.Builder	provenanceEnabled(Boolean provenanceEnabled)	Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.healthlake.model.HealthLakeRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

inputDataConfig

StartDataTransformationJobRequest.Builder inputDataConfig(TransformationInputDataConfig inputDataConfig)

The Amazon S3 location and format of the source files to transform.

Parameters:

inputDataConfig - The Amazon S3 location and format of the source files to transform.

Returns:

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

inputDataConfig

default StartDataTransformationJobRequest.Builder inputDataConfig(Consumer<TransformationInputDataConfig.Builder> inputDataConfig)

The Amazon S3 location and format of the source files to transform.

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

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

Parameters:

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

Returns:

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

See Also:

• inputDataConfig(TransformationInputDataConfig)

outputDataConfig

StartDataTransformationJobRequest.Builder outputDataConfig(TransformationOutputDataConfig outputDataConfig)

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

Parameters:

outputDataConfig - The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

Returns:

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

outputDataConfig

default StartDataTransformationJobRequest.Builder outputDataConfig(Consumer<TransformationOutputDataConfig.Builder> outputDataConfig)

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

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

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

Parameters:

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

Returns:

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

See Also:

• outputDataConfig(TransformationOutputDataConfig)

dataAccessRoleArn

StartDataTransformationJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.

Returns:

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

clientToken

StartDataTransformationJobRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

Returns:

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

jobName

StartDataTransformationJobRequest.Builder jobName(String jobName)

A descriptive name for the data transformation job.

Parameters:

jobName - A descriptive name for the data transformation job.

Returns:

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

profileId

StartDataTransformationJobRequest.Builder profileId(String profileId)

The unique identifier of the data transformation profile to use for conversion.

Parameters:

profileId - The unique identifier of the data transformation profile to use for conversion.

Returns:

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

driftDetectionEnabled

StartDataTransformationJobRequest.Builder driftDetectionEnabled(Boolean driftDetectionEnabled)

Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

Parameters:

driftDetectionEnabled - Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

Returns:

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

provenanceEnabled

StartDataTransformationJobRequest.Builder provenanceEnabled(Boolean provenanceEnabled)

Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

Parameters:

provenanceEnabled - Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

Returns:

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

overrideConfiguration

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

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