Class StartDataTransformationJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.healthlake.model.HealthLakeRequest
software.amazon.awssdk.services.healthlake.model.StartDataTransformationJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartDataTransformationJobRequest extends HealthLakeRequest implements ToCopyableBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>

The request parameters for the StartDataTransformationJob operation.

  • Method Details

    • inputDataConfig

      public final TransformationInputDataConfig inputDataConfig()

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

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

    • outputDataConfig

      public final TransformationOutputDataConfig outputDataConfig()

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

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

    • dataAccessRoleArn

      public final 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.

      Returns:
      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.

    • clientToken

      public final 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.

      Returns:
      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.

    • jobName

      public final String jobName()

      A descriptive name for the data transformation job.

      Returns:
      A descriptive name for the data transformation job.

    • profileId

      public final String profileId()

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

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

    • driftDetectionEnabled

      public final 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.

      Returns:
      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.

    • provenanceEnabled

      public final 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.

      Returns:
      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.

    • toBuilder

      public StartDataTransformationJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartDataTransformationJobRequest.Builder,StartDataTransformationJobRequest>
      Specified by:
      toBuilder in class HealthLakeRequest
      Returns:
      a builder for type T

    • builder

      public static StartDataTransformationJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartDataTransformationJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.