Interface TransformationJobProperties.Builder

All Superinterfaces:

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

Enclosing class:

TransformationJobProperties

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

Method Summary

Modifier and Type	Method	Description
TransformationJobProperties.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations.
TransformationJobProperties.Builder	driftDetectionEnabled(Boolean driftDetectionEnabled)	Specifies whether drift detection is enabled for this job.
TransformationJobProperties.Builder	endTime(Instant endTime)	The timestamp when the job completed or failed.
default TransformationJobProperties.Builder	inputDataConfig(Consumer<TransformationInputDataConfig.Builder> inputDataConfig)	The Amazon S3 location and format of the source files for this job.
TransformationJobProperties.Builder	inputDataConfig(TransformationInputDataConfig inputDataConfig)	The Amazon S3 location and format of the source files for this job.
TransformationJobProperties.Builder	jobId(String jobId)	The unique identifier of the data transformation job.
TransformationJobProperties.Builder	jobName(String jobName)	The name of the data transformation job.
default TransformationJobProperties.Builder	jobProgressReport(Consumer<TransformationJobProgressReport.Builder> jobProgressReport)	The progress report for the data transformation job, including counts of files processed and resources generated.
TransformationJobProperties.Builder	jobProgressReport(TransformationJobProgressReport jobProgressReport)	The progress report for the data transformation job, including counts of files processed and resources generated.
TransformationJobProperties.Builder	jobStatus(String jobStatus)	The current status of the data transformation job.
TransformationJobProperties.Builder	jobStatus(TransformationJobStatus jobStatus)	The current status of the data transformation job.
TransformationJobProperties.Builder	message(String message)	An informational message about the job, such as an error description if the job failed.
default TransformationJobProperties.Builder	outputDataConfig(Consumer<TransformationOutputDataConfig.Builder> outputDataConfig)	The Amazon S3 location and encryption configuration for the converted output.
TransformationJobProperties.Builder	outputDataConfig(TransformationOutputDataConfig outputDataConfig)	The Amazon S3 location and encryption configuration for the converted output.
TransformationJobProperties.Builder	profileId(String profileId)	The unique identifier of the data transformation profile used for this job.
TransformationJobProperties.Builder	profileName(String profileName)	The name of the data transformation profile used for this job.
TransformationJobProperties.Builder	profileVersion(Integer profileVersion)	The version number of the data transformation profile used for this job.
TransformationJobProperties.Builder	provenanceEnabled(Boolean provenanceEnabled)	Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job.
TransformationJobProperties.Builder	submitTime(Instant submitTime)	The timestamp when the job was submitted.

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, sdkFieldNameToField, sdkFields

Method Details

jobId

TransformationJobProperties.Builder jobId(String jobId)

The unique identifier of the data transformation job.

Parameters:

jobId - The unique identifier of the data transformation job.

Returns:

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

jobStatus

TransformationJobProperties.Builder jobStatus(String jobStatus)

The current status of the data transformation job.

Parameters:

jobStatus - The current status of the data transformation job.

Returns:

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

See Also:

• TransformationJobStatus
• TransformationJobStatus

jobStatus

TransformationJobProperties.Builder jobStatus(TransformationJobStatus jobStatus)

The current status of the data transformation job.

Parameters:

jobStatus - The current status of the data transformation job.

Returns:

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

See Also:

• TransformationJobStatus
• TransformationJobStatus

inputDataConfig

TransformationJobProperties.Builder inputDataConfig(TransformationInputDataConfig inputDataConfig)

The Amazon S3 location and format of the source files for this job.

Parameters:

inputDataConfig - The Amazon S3 location and format of the source files for this job.

Returns:

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

inputDataConfig

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

The Amazon S3 location and format of the source files for this job.

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

TransformationJobProperties.Builder outputDataConfig(TransformationOutputDataConfig outputDataConfig)

The Amazon S3 location and encryption configuration for the converted output.

Parameters:

outputDataConfig - The Amazon S3 location and encryption configuration for the converted output.

Returns:

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

outputDataConfig

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

The Amazon S3 location and encryption configuration for the converted output.

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

TransformationJobProperties.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files.

Parameters:

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

Returns:

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

submitTime

TransformationJobProperties.Builder submitTime(Instant submitTime)

The timestamp when the job was submitted.

Parameters:

submitTime - The timestamp when the job was submitted.

Returns:

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

jobName

TransformationJobProperties.Builder jobName(String jobName)

The name of the data transformation job.

Parameters:

jobName - The name of the data transformation job.

Returns:

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

profileId

TransformationJobProperties.Builder profileId(String profileId)

The unique identifier of the data transformation profile used for this job.

Parameters:

profileId - The unique identifier of the data transformation profile used for this job.

Returns:

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

profileName

TransformationJobProperties.Builder profileName(String profileName)

The name of the data transformation profile used for this job.

Parameters:

profileName - The name of the data transformation profile used for this job.

Returns:

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

profileVersion

TransformationJobProperties.Builder profileVersion(Integer profileVersion)

The version number of the data transformation profile used for this job.

Parameters:

profileVersion - The version number of the data transformation profile used for this job.

Returns:

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

endTime

TransformationJobProperties.Builder endTime(Instant endTime)

The timestamp when the job completed or failed.

Parameters:

endTime - The timestamp when the job completed or failed.

Returns:

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

driftDetectionEnabled

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

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

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.

Returns:

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

message

TransformationJobProperties.Builder message(String message)

An informational message about the job, such as an error description if the job failed.

Parameters:

message - An informational message about the job, such as an error description if the job failed.

Returns:

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

jobProgressReport

TransformationJobProperties.Builder jobProgressReport(TransformationJobProgressReport jobProgressReport)

The progress report for the data transformation job, including counts of files processed and resources generated.

Parameters:

jobProgressReport - The progress report for the data transformation job, including counts of files processed and resources generated.

Returns:

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

jobProgressReport

default TransformationJobProperties.Builder jobProgressReport(Consumer<TransformationJobProgressReport.Builder> jobProgressReport)

The progress report for the data transformation job, including counts of files processed and resources generated.

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

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

Parameters:

jobProgressReport - a consumer that will call methods on TransformationJobProgressReport.Builder

Returns:

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

See Also:

• jobProgressReport(TransformationJobProgressReport)