Interface DescribeDatasetResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeDatasetResponse
@Mutable @NotThreadSafe public static interface DescribeDatasetResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

  • Method Details

    • datasetId

      DescribeDatasetResponse.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.

    • datasetArn

      DescribeDatasetResponse.Builder datasetArn(String datasetArn)

      The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

      Parameters:
      datasetArn - The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetName

      DescribeDatasetResponse.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

      DescribeDatasetResponse.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

      DescribeDatasetResponse.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

      DescribeDatasetResponse.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

      DescribeDatasetResponse.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 DescribeDatasetResponse.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

      DescribeDatasetResponse.Builder workspaceName(String workspaceName)

      The name of the workspace that contains the dataset.

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

    • metadata

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

      The metadata for the dataset.

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

    • datasetSource

      DescribeDatasetResponse.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 DescribeDatasetResponse.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:

    • datasetStatus

      DescribeDatasetResponse.Builder datasetStatus(DatasetStatus datasetStatus)

      The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

      Parameters:
      datasetStatus - The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetStatus

      default DescribeDatasetResponse.Builder datasetStatus(Consumer<DatasetStatus.Builder> datasetStatus)

      The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

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

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

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

    • datasetCreationDate

      DescribeDatasetResponse.Builder datasetCreationDate(Instant datasetCreationDate)

      The dataset creation date, in Unix epoch time.

      Parameters:
      datasetCreationDate - The dataset creation date, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetLastUpdateDate

      DescribeDatasetResponse.Builder datasetLastUpdateDate(Instant datasetLastUpdateDate)

      The date the dataset was last updated, in Unix epoch time.

      Parameters:
      datasetLastUpdateDate - The date the dataset was last updated, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetVersion

      DescribeDatasetResponse.Builder datasetVersion(String datasetVersion)

      The version of the dataset.

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

    • enrichmentStatus

      DescribeDatasetResponse.Builder enrichmentStatus(DatasetEnrichment enrichmentStatus)

      The enrichment status of the dataset.

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

    • enrichmentStatus

      default DescribeDatasetResponse.Builder enrichmentStatus(Consumer<DatasetEnrichment.Builder> enrichmentStatus)

      The enrichment status of the dataset.

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

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

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