Package software.amazon.awssdk.services.lookoutvision.model

Class CreateDatasetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lookoutvision.model.LookoutVisionRequest

software.amazon.awssdk.services.lookoutvision.model.CreateDatasetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDatasetRequest
extends LookoutVisionRequest
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	clientToken()	ClientToken is an idempotency token that ensures a call to CreateDataset completes only once.
DatasetSource	datasetSource()	The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
String	datasetType()	The type of the dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	projectName()	The name of the project in which you want to create a dataset.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDatasetRequest.Builder>	serializableBuilderClass()
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

projectName

public final String projectName()

The name of the project in which you want to create a dataset.

Returns:

The name of the project in which you want to create a dataset.

datasetType

public final String datasetType()

The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

Returns:

The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

datasetSource

public final DatasetSource datasetSource()

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

If you don't specify DatasetSource, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.

If you specify a value for DataSource, the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset.

Returns:

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

If you don't specify DatasetSource, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.

If you specify a value for DataSource, the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset.

clientToken

public final String clientToken()

ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateDataset. In this case, safely retry your call to CreateDataset by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateDataset. An idempotency token is active for 8 hours.

Returns:

ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateDataset. In this case, safely retry your call to CreateDataset by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateDataset. An idempotency token is active for 8 hours.

toBuilder

public CreateDatasetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Specified by:

toBuilder in class LookoutVisionRequest

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