Class DICOMImportJobProperties

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

Properties of the import job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The import job identifier.

      Returns:
      The import job identifier.

    • jobName

      public final String jobName()

      The import job name.

      Returns:
      The import job name.

    • jobStatus

      public final JobStatus jobStatus()

      The filters for listing import jobs based on status.

      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 filters for listing import jobs based on status.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The filters for listing import jobs based on status.

      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 filters for listing import jobs based on status.
      See Also:

    • datastoreId

      public final String datastoreId()

      The data store identifier.

      Returns:
      The data store identifier.

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

      Returns:
      The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

    • endedAt

      public final Instant endedAt()

      The timestamp for when the import job was ended.

      Returns:
      The timestamp for when the import job was ended.

    • submittedAt

      public final Instant submittedAt()

      The timestamp for when the import job was submitted.

      Returns:
      The timestamp for when the import job was submitted.

    • inputS3Uri

      public final String inputS3Uri()

      The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.

      Returns:
      The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.

    • outputS3Uri

      public final String outputS3Uri()

      The output prefix of the S3 bucket to upload the results of the DICOM import job.

      Returns:
      The output prefix of the S3 bucket to upload the results of the DICOM import job.

    • message

      public final String message()

      The error message thrown if an import job fails.

      Returns:
      The error message thrown if an import job fails.

    • toBuilder

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

    • builder

      public static DICOMImportJobProperties.Builder builder()

    • serializableBuilderClass

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