software.amazon.awssdk.services.comprehend.model

Class KeyPhrasesDetectionJobProperties

java.lang.Object

software.amazon.awssdk.services.comprehend.model.KeyPhrasesDetectionJobProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KeyPhrasesDetectionJobProperties.Builder,KeyPhrasesDetectionJobProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class KeyPhrasesDetectionJobProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeyPhrasesDetectionJobProperties.Builder,KeyPhrasesDetectionJobProperties>

Provides information about a key phrases detection job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyPhrasesDetectionJobProperties.Builder

Method Summary

Modifier and Type	Method and Description
static KeyPhrasesDetectionJobProperties.Builder	builder()
String	dataAccessRoleArn() The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Instant	endTime() The time that the key phrases detection job completed.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputDataConfig	inputDataConfig() The input data configuration that you supplied when you created the key phrases detection job.
String	jobId() The identifier assigned to the key phrases detection job.
String	jobName() The name that you assigned the key phrases detection job.
JobStatus	jobStatus() The current status of the key phrases detection job.
String	jobStatusAsString() The current status of the key phrases detection job.
LanguageCode	languageCode() The language code of the input documents.
String	languageCodeAsString() The language code of the input documents.
String	message() A description of the status of a job.
OutputDataConfig	outputDataConfig() The output data configuration that you supplied when you created the key phrases detection job.
List<SdkField<?>>	sdkFields()
static Class<? extends KeyPhrasesDetectionJobProperties.Builder>	serializableBuilderClass()
Instant	submitTime() The time that the key phrases detection job was submitted for processing.
KeyPhrasesDetectionJobProperties.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 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 assigned to the key phrases detection job.

Returns:

The identifier assigned to the key phrases detection job.

jobName

public String jobName()

The name that you assigned the key phrases detection job.

Returns:

The name that you assigned the key phrases detection job.

jobStatus

public JobStatus jobStatus()

The current status of the key phrases 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 key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

See Also:

JobStatus

jobStatusAsString

public String jobStatusAsString()

The current status of the key phrases 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 key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

See Also:

JobStatus

message

public String message()

A description of the status of a job.

Returns:

A description of the status of a job.

submitTime

public Instant submitTime()

The time that the key phrases detection job was submitted for processing.

Returns:

The time that the key phrases detection job was submitted for processing.

endTime

public Instant endTime()

The time that the key phrases detection job completed.

Returns:

The time that the key phrases detection job completed.

inputDataConfig

public InputDataConfig inputDataConfig()

The input data configuration that you supplied when you created the key phrases detection job.

Returns:

The input data configuration that you supplied when you created the key phrases detection job.

outputDataConfig

public OutputDataConfig outputDataConfig()

The output data configuration that you supplied when you created the key phrases detection job.

Returns:

The output data configuration that you supplied when you created the key phrases detection job.

languageCode

public 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 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 String dataAccessRoleArn()

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Returns:

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

toBuilder

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

Returns:

a builder for type T

builder

public static KeyPhrasesDetectionJobProperties.Builder builder()

serializableBuilderClass

public static Class<? extends KeyPhrasesDetectionJobProperties.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)

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.