Class CreateDatasetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDatasetRequest.Builder,
CreateDatasetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateDatasetRequest.Builder
builder()
final String
ClientToken is an idempotency token that ensures a call toCreateDataset
completes only once.final DatasetSource
The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.final String
The type of the dataset.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The name of the project in which you want to create a dataset.static Class
<? extends CreateDatasetRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The type of the dataset. Specify
train
for a training dataset. Specifytest
for a test dataset.- Returns:
- The type of the dataset. Specify
train
for a training dataset. Specifytest
for a test dataset.
-
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 toCreateDataset
is asynchronous and might take a while to complete. To find out the current status, Check the value ofStatus
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 toCreateDataset
is asynchronous and might take a while to complete. To find out the current status, Check the value ofStatus
returned in a call to DescribeDataset.
-
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 fromCreateDataset
. In this case, safely retry your call toCreateDataset
by using the sameClientToken
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 toCreateDataset
. 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 fromCreateDataset
. In this case, safely retry your call toCreateDataset
by using the sameClientToken
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 toCreateDataset
. An idempotency token is active for 8 hours.
-
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 interfaceToCopyableBuilder<CreateDatasetRequest.Builder,
CreateDatasetRequest> - Specified by:
toBuilder
in classLookoutVisionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-