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

Class CreateDatasetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.CreateDatasetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDatasetRequest
extends ComprehendRequest
implements ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDatasetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDatasetRequest.Builder	builder()
String	clientRequestToken()	A unique identifier for the request.
String	datasetName()	Name of the dataset.
DatasetType	datasetType()	The dataset type.
String	datasetTypeAsString()	The dataset type.
String	description()	Description of the dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelArn()	The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
DatasetInputDataConfig	inputDataConfig()	Information about the input data configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDatasetRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Tags for the dataset.
CreateDatasetRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

flywheelArn

public final String flywheelArn()

The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

Returns:

The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

datasetName

public final String datasetName()

Name of the dataset.

Returns:

Name of the dataset.

datasetType

public final DatasetType datasetType()

The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

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. You can specify that the data in a dataset is for training the model or for testing the model.

See Also:

DatasetType

datasetTypeAsString

public final String datasetTypeAsString()

The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

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. You can specify that the data in a dataset is for training the model or for testing the model.

See Also:

DatasetType

description

public final String description()

Description of the dataset.

Returns:

Description of the dataset.

inputDataConfig

public final DatasetInputDataConfig inputDataConfig()

Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

Returns:

Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

clientRequestToken

public final String clientRequestToken()

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Tags for the dataset.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Tags for the dataset.

toBuilder

public CreateDatasetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static CreateDatasetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo