Interface CreateDatasetRequest.Builder

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

  • Method Details

    • datasetId

      CreateDatasetRequest.Builder datasetId(String datasetId)

      The ID of the dataset.

      Parameters:
      datasetId - The ID of the dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetName

      CreateDatasetRequest.Builder datasetName(String datasetName)

      The name of the dataset.

      Parameters:
      datasetName - The name of the dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetDescription

      CreateDatasetRequest.Builder datasetDescription(String datasetDescription)

      A description about the dataset, and its functionality.

      Parameters:
      datasetDescription - A description about the dataset, and its functionality.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetType

      CreateDatasetRequest.Builder datasetType(String datasetType)

      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

      Parameters:
      datasetType - The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • datasetType

      CreateDatasetRequest.Builder datasetType(DatasetTypeEnum datasetType)

      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

      Parameters:
      datasetType - The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • datasetConfig

      CreateDatasetRequest.Builder datasetConfig(DatasetConfig datasetConfig)

      The configuration for the dataset.

      Parameters:
      datasetConfig - The configuration for the dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetConfig

      default CreateDatasetRequest.Builder datasetConfig(Consumer<DatasetConfig.Builder> datasetConfig)

      The configuration for the dataset.

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

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

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

    • workspaceName

      CreateDatasetRequest.Builder workspaceName(String workspaceName)

      The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.

      Parameters:
      workspaceName - The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadata

      CreateDatasetRequest.Builder metadata(Map<String,String> metadata)

      The metadata for the dataset, provided as key-value pairs.

      Parameters:
      metadata - The metadata for the dataset, provided as key-value pairs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetSource

      CreateDatasetRequest.Builder datasetSource(DatasetSource datasetSource)

      The data source for the dataset.

      Parameters:
      datasetSource - The data source for the dataset.
      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 data source for the dataset.

      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)

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      Parameters:
      clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDatasetRequest.Builder tags(Map<String,String> tags)

      A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

      Parameters:
      tags - A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
      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.