Package software.amazon.awssdk.services.healthlake.model

Class ExportJobProperties

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

The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The AWS generated ID for an export job.

      Returns:
      The AWS generated ID for an export job.

    • jobName

      public final String jobName()

      The user generated name for an export job.

      Returns:
      The user generated name for an export job.

    • jobStatus

      public final JobStatus jobStatus()

      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

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

      Returns:
      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

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

      Returns:
      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
      See Also:

    • submitTime

      public final Instant submitTime()

      The time an export job was initiated.

      Returns:
      The time an export job was initiated.

    • endTime

      public final Instant endTime()

      The time an export job completed.

      Returns:
      The time an export job completed.

    • datastoreId

      public final String datastoreId()

      The AWS generated ID for the data store from which files are being exported for an export job.

      Returns:
      The AWS generated ID for the data store from which files are being exported for an export job.

    • outputDataConfig

      public final OutputDataConfig outputDataConfig()

      The output data configuration that was supplied when the export job was created.

      Returns:
      The output data configuration that was supplied when the export job was created.

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name used during the initiation of the job.

      Returns:
      The Amazon Resource Name used during the initiation of the job.

    • message

      public final String message()

      An explanation of any errors that may have occurred during the export job.

      Returns:
      An explanation of any errors that may have occurred during the export job.

    • toBuilder

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

    • builder

      public static ExportJobProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportJobProperties.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.