software.amazon.awssdk.services.comprehend.model

Class StartEntitiesDetectionJobResponse

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.StartEntitiesDetectionJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartEntitiesDetectionJobResponse.Builder,StartEntitiesDetectionJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartEntitiesDetectionJobResponse
extends ComprehendResponse
implements ToCopyableBuilder<StartEntitiesDetectionJobResponse.Builder,StartEntitiesDetectionJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartEntitiesDetectionJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static StartEntitiesDetectionJobResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	jobId() The identifier generated for the job.
JobStatus	jobStatus() The status of the job.
String	jobStatusAsString() The status of the job.
List<SdkField<?>>	sdkFields()
static Class<? extends StartEntitiesDetectionJobResponse.Builder>	serializableBuilderClass()
StartEntitiesDetectionJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobId

public String jobId()

The identifier generated for the job. To get the status of job, use this identifier with the operation.

Returns:

The identifier generated for the job. To get the status of job, use this identifier with the operation.

jobStatus

public JobStatus jobStatus()

The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the 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 is 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. To get details, use the 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:

JobStatus

jobStatusAsString

public String jobStatusAsString()

The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the 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 is 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. To get details, use the 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:

JobStatus

toBuilder

public StartEntitiesDetectionJobResponse.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<StartEntitiesDetectionJobResponse.Builder,StartEntitiesDetectionJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static StartEntitiesDetectionJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.