software.amazon.awssdk.services.comprehend.model

Class DatasetProperties

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DatasetProperties

All Implemented Interfaces:

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

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

Properties associated with the dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DatasetProperties.Builder

Method Summary

Modifier and Type	Method and Description
static DatasetProperties.Builder	builder()
Instant	creationTime() Creation time of the dataset.
String	datasetArn() The ARN of the dataset.
String	datasetName() The name of the dataset.
String	datasetS3Uri() The S3 URI where the dataset is stored.
DatasetType	datasetType() The dataset type (training data or test data).
String	datasetTypeAsString() The dataset type (training data or test data).
String	description() Description of the dataset.
Instant	endTime() Time when the data from the dataset becomes available in the data lake.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message() A description of the status of the dataset.
Long	numberOfDocuments() The number of documents in the dataset.
List<SdkField<?>>	sdkFields()
static Class<? extends DatasetProperties.Builder>	serializableBuilderClass()
DatasetStatus	status() The dataset status.
String	statusAsString() The dataset status.
DatasetProperties.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

datasetArn

public final String datasetArn()

The ARN of the dataset.

Returns:

The ARN of the dataset.

datasetName

public final String datasetName()

The name of the dataset.

Returns:

The name of the dataset.

datasetType

public final DatasetType datasetType()

The dataset type (training data or test data).

If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

Returns:

The dataset type (training data or test data).

See Also:

DatasetType

datasetTypeAsString

public final String datasetTypeAsString()

The dataset type (training data or test data).

If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

Returns:

The dataset type (training data or test data).

See Also:

DatasetType

datasetS3Uri

public final String datasetS3Uri()

The S3 URI where the dataset is stored.

Returns:

The S3 URI where the dataset is stored.

description

public final String description()

Description of the dataset.

Returns:

Description of the dataset.

status

public final DatasetStatus status()

The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

If the service returns an enum value that is not available in the current SDK version, status will return DatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

See Also:

DatasetStatus

statusAsString

public final String statusAsString()

The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

If the service returns an enum value that is not available in the current SDK version, status will return DatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

See Also:

DatasetStatus

message

public final String message()

A description of the status of the dataset.

Returns:

A description of the status of the dataset.

numberOfDocuments

public final Long numberOfDocuments()

The number of documents in the dataset.

Returns:

The number of documents in the dataset.

creationTime

public final Instant creationTime()

Creation time of the dataset.

Returns:

Creation time of the dataset.

endTime

public final Instant endTime()

Time when the data from the dataset becomes available in the data lake.

Returns:

Time when the data from the dataset becomes available in the data lake.

toBuilder

public DatasetProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetProperties.Builder,DatasetProperties>

builder

public static DatasetProperties.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo