Class StartDocumentClassificationJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,
StartDocumentClassificationJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the custom classification model.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
jobArn()
The Amazon Resource Name (ARN) of the document classification job.final String
jobId()
The identifier generated for the job.final JobStatus
The status of the job:final String
The status of the job:static Class
<? extends StartDocumentClassificationJobResponse.Builder> 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 class software.amazon.awssdk.services.comprehend.model.ComprehendResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
The identifier generated for the job. To get the status of the job, use this identifier with the
DescribeDocumentClassificationJob
operation.- Returns:
- The identifier generated for the job. To get the status of the job, use this identifier with the
DescribeDocumentClassificationJob
operation.
-
jobArn
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
- Returns:
- The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified
identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the
job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
-
jobStatus
The status of the job:
-
SUBMITTED - The job has been received and queued for processing.
-
IN_PROGRESS - Amazon Comprehend is processing the job.
-
COMPLETED - The job was successfully completed and the output is available.
-
FAILED - The job did not complete. For details, use the
DescribeDocumentClassificationJob
operation. -
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
-
STOPPED - The job was successfully stopped without completing.
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 status of the job:
-
SUBMITTED - The job has been received and queued for processing.
-
IN_PROGRESS - Amazon Comprehend is processing the job.
-
COMPLETED - The job was successfully completed and the output is available.
-
FAILED - The job did not complete. For details, use the
DescribeDocumentClassificationJob
operation. -
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
-
STOPPED - The job was successfully stopped without completing.
-
- See Also:
-
-
jobStatusAsString
The status of the job:
-
SUBMITTED - The job has been received and queued for processing.
-
IN_PROGRESS - Amazon Comprehend is processing the job.
-
COMPLETED - The job was successfully completed and the output is available.
-
FAILED - The job did not complete. For details, use the
DescribeDocumentClassificationJob
operation. -
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
-
STOPPED - The job was successfully stopped without completing.
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 status of the job:
-
SUBMITTED - The job has been received and queued for processing.
-
IN_PROGRESS - Amazon Comprehend is processing the job.
-
COMPLETED - The job was successfully completed and the output is available.
-
FAILED - The job did not complete. For details, use the
DescribeDocumentClassificationJob
operation. -
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
-
STOPPED - The job was successfully stopped without completing.
-
- See Also:
-
-
documentClassifierArn
The ARN of the custom classification model.
- Returns:
- The ARN of the custom classification model.
-
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<StartDocumentClassificationJobResponse.Builder,
StartDocumentClassificationJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StartDocumentClassificationJobResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-