Class ComprehendMedicalAsyncJobProperties

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

Provides information about a detection job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The identifier assigned to the detection job.

      Returns:
      The identifier assigned to the detection job.

    • jobName

      public final String jobName()

      The name that you assigned to the detection job.

      Returns:
      The name that you assigned to the detection job.

    • jobStatus

      public final JobStatus jobStatus()

      The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

      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 current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

      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 current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.
      See Also:

    • message

      public final String message()

      A description of the status of a job.

      Returns:
      A description of the status of a job.

    • submitTime

      public final Instant submitTime()

      The time that the detection job was submitted for processing.

      Returns:
      The time that the detection job was submitted for processing.

    • endTime

      public final Instant endTime()

      The time that the detection job completed.

      Returns:
      The time that the detection job completed.

    • expirationTime

      public final Instant expirationTime()

      The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

      Returns:
      The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

    • inputDataConfig

      public final InputDataConfig inputDataConfig()

      The input data configuration that you supplied when you created the detection job.

      Returns:
      The input data configuration that you supplied when you created the detection job.

    • outputDataConfig

      public final OutputDataConfig outputDataConfig()

      The output data configuration that you supplied when you created the detection job.

      Returns:
      The output data configuration that you supplied when you created the detection job.

    • languageCode

      public final LanguageCode languageCode()

      The language code of the input documents.

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

      Returns:
      The language code of the input documents.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code of the input documents.

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

      Returns:
      The language code of the input documents.
      See Also:

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

      Returns:
      The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

    • manifestFilePath

      public final String manifestFilePath()

      The path to the file that describes the results of a batch job.

      Returns:
      The path to the file that describes the results of a batch job.

    • kmsKey

      public final String kmsKey()

      The AWS Key Management Service key, if any, used to encrypt the output files.

      Returns:
      The AWS Key Management Service key, if any, used to encrypt the output files.

    • modelVersion

      public final String modelVersion()

      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

      Returns:
      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

    • toBuilder

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

    • builder

      public static ComprehendMedicalAsyncJobProperties.Builder builder()

    • serializableBuilderClass

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