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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ComprehendMedicalAsyncJobProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ComprehendMedicalAsyncJobProperties.Builder`	`builder()`
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
`Instant`	`endTime()`	The time that the detection job completed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`expirationTime()`	The date and time that job metadata is deleted from the server.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InputDataConfig`	`inputDataConfig()`	The input data configuration that you supplied when you created the detection job.
`String`	`jobId()`	The identifier assigned to the detection job.
`String`	`jobName()`	The name that you assigned to the detection job.
`JobStatus`	`jobStatus()`	The current status of the detection job.
`String`	`jobStatusAsString()`	The current status of the detection job.
`String`	`kmsKey()`	The AWS Key Management Service key, if any, used to encrypt the output files.
`LanguageCode`	`languageCode()`	The language code of the input documents.
`String`	`languageCodeAsString()`	The language code of the input documents.
`String`	`manifestFilePath()`	The path to the file that describes the results of a batch job.
`String`	`message()`	A description of the status of a job.
`String`	`modelVersion()`	The version of the model used to analyze the documents.
`OutputDataConfig`	`outputDataConfig()`	The output data configuration that you supplied when you created the detection job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ComprehendMedicalAsyncJobProperties.Builder>`	`serializableBuilderClass()`
`Instant`	`submitTime()`	The time that the detection job was submitted for processing.
`ComprehendMedicalAsyncJobProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    JobStatus
  - 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:
    
    JobStatus
  - 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:
    
    LanguageCode
  - 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:
    
    LanguageCode
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComprehendMedicalAsyncJobProperties.Builder,ComprehendMedicalAsyncJobProperties>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ComprehendMedicalAsyncJobProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

jobName

jobStatus

jobStatusAsString

message

submitTime

endTime

expirationTime

inputDataConfig

outputDataConfig

languageCode

languageCodeAsString

dataAccessRoleArn

manifestFilePath

kmsKey

modelVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields