Interface DatasetSummary.Builder

  • Method Details

    • id

      The ID of the dataset.

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

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

      Parameters:
      arn - 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.
    • name

      The name of the dataset.

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

      DatasetSummary.Builder description(String description)

      A description about the dataset, and its functionality.

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

      DatasetSummary.Builder sourceType(String sourceType)

      The data source type of the dataset.

      Parameters:
      sourceType - The data source type of the dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sourceType

      DatasetSummary.Builder sourceType(DatasetSourceType sourceType)

      The data source type of the dataset.

      Parameters:
      sourceType - The data source type of the dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • datasetType

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

      DatasetSummary.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:
    • creationDate

      DatasetSummary.Builder creationDate(Instant creationDate)

      The dataset creation date, in Unix epoch time.

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

      DatasetSummary.Builder lastUpdateDate(Instant lastUpdateDate)

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

      Parameters:
      lastUpdateDate - 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.
    • status

      The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

      Parameters:
      status - The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the dataset. This contains the state and any error messages. 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 status(DatasetStatus).

      Parameters:
      status - 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:
    • enrichmentStatus

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