Class ComprehendMedicalAsyncJobProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComprehendMedicalAsyncJobProperties.Builder,
ComprehendMedicalAsyncJobProperties>
Provides information about a detection job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.final Instant
endTime()
The time that the detection job completed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The date and time that job metadata is deleted from the server.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InputDataConfig
The input data configuration that you supplied when you created the detection job.final String
jobId()
The identifier assigned to the detection job.final String
jobName()
The name that you assigned to the detection job.final JobStatus
The current status of the detection job.final String
The current status of the detection job.final String
kmsKey()
The AWS Key Management Service key, if any, used to encrypt the output files.final LanguageCode
The language code of the input documents.final String
The language code of the input documents.final String
The path to the file that describes the results of a batch job.final String
message()
A description of the status of a job.final String
The version of the model used to analyze the documents.final OutputDataConfig
The output data configuration that you supplied when you created the detection job.static Class
<? extends ComprehendMedicalAsyncJobProperties.Builder> final Instant
The time that the detection job was submitted for processing.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
The identifier assigned to the detection job.
- Returns:
- The identifier assigned to the detection job.
-
jobName
The name that you assigned to the detection job.
- Returns:
- The name that you assigned to the detection job.
-
jobStatus
The current status of the detection job. If the status is
FAILED
, theMessage
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the detection job. If the status is
FAILED
, theMessage
field shows the reason for the failure. - See Also:
-
jobStatusAsString
The current status of the detection job. If the status is
FAILED
, theMessage
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the detection job. If the status is
FAILED
, theMessage
field shows the reason for the failure. - See Also:
-
message
A description of the status of a job.
- Returns:
- A description of the status of a job.
-
submitTime
The time that the detection job was submitted for processing.
- Returns:
- The time that the detection job was submitted for processing.
-
endTime
The time that the detection job completed.
- Returns:
- The time that the detection job completed.
-
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 theListPHIDetectionJobs
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 theListPHIDetectionJobs
operation.
-
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
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
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 returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the input documents.
- See Also:
-
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 returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the input documents.
- See Also:
-
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
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
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
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
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 interfaceToCopyableBuilder<ComprehendMedicalAsyncJobProperties.Builder,
ComprehendMedicalAsyncJobProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ComprehendMedicalAsyncJobProperties.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-