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

Interface CreateDatasetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>, LookoutVisionRequest.Builder, SdkBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDatasetRequest
public static interface CreateDatasetRequest.Builder extends LookoutVisionRequest.Builder, SdkPojo, CopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

  • Method Details

    • projectName

      CreateDatasetRequest.Builder projectName(String projectName)

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

      Parameters:
      projectName - The name of the project in which you want to create a dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetType

      CreateDatasetRequest.Builder datasetType(String datasetType)

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

      Parameters:
      datasetType - The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetSource

      CreateDatasetRequest.Builder datasetSource(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • datasetSource

      default CreateDatasetRequest.Builder datasetSource(Consumer<DatasetSource.Builder> 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.

      This is a convenience method that creates an instance of the DatasetSource.Builder avoiding the need to create one manually via DatasetSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetSource(DatasetSource).

      Parameters:
      datasetSource - a consumer that will call methods on DatasetSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateDatasetRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateDatasetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDatasetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.