Class TransformationJobProperties

java.lang.Object
software.amazon.awssdk.services.healthlake.model.TransformationJobProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TransformationJobProperties.Builder,TransformationJobProperties>
@Generated("software.amazon.awssdk:codegen") public final class TransformationJobProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TransformationJobProperties.Builder,TransformationJobProperties>

Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling DescribeDataTransformationJob.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the data transformation job.

      Returns:
      The unique identifier of the data transformation job.

    • jobStatus

      public final TransformationJobStatus jobStatus()

      The current status of the data transformation job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return TransformationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The current status of the data transformation job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the data transformation job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return TransformationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The current status of the data transformation job.
      See Also:

    • inputDataConfig

      public final TransformationInputDataConfig inputDataConfig()

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

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

    • outputDataConfig

      public final TransformationOutputDataConfig outputDataConfig()

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

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

    • dataAccessRoleArn

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

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

    • submitTime

      public final Instant submitTime()

      The timestamp when the job was submitted.

      Returns:
      The timestamp when the job was submitted.

    • jobName

      public final String jobName()

      The name of the data transformation job.

      Returns:
      The name of the data transformation job.

    • profileId

      public final String profileId()

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

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

    • profileName

      public final String profileName()

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

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

    • profileVersion

      public final Integer profileVersion()

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

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

    • endTime

      public final Instant endTime()

      The timestamp when the job completed or failed.

      Returns:
      The timestamp when the job completed or failed.

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

      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.

    • message

      public final String message()

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

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

    • jobProgressReport

      public final TransformationJobProgressReport jobProgressReport()

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

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

    • toBuilder

      public TransformationJobProperties.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<TransformationJobProperties.Builder,TransformationJobProperties>
      Returns:
      a builder for type T

    • builder

      public static TransformationJobProperties.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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