Package software.amazon.awssdk.services.comprehend.model

Class StartDocumentClassificationJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.comprehend.model.ComprehendResponse
software.amazon.awssdk.services.comprehend.model.StartDocumentClassificationJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartDocumentClassificationJobResponse extends ComprehendResponse implements ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>

  • Method Details

    • jobId

      public final String 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

      public final String 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

      public final JobStatus 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      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

      public final String 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      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

      public final String documentClassifierArn()

      The ARN of the custom classification model.

      Returns:
      The ARN of the custom classification model.

    • toBuilder

      public StartDocumentClassificationJobResponse.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<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static StartDocumentClassificationJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartDocumentClassificationJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.