Package software.amazon.awssdk.services.iotanalytics.model

Interface Datastore.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Datastore.Builder,Datastore>, SdkBuilder<Datastore.Builder,Datastore>, SdkPojo
Enclosing class:
Datastore
public static interface Datastore.Builder extends SdkPojo, CopyableBuilder<Datastore.Builder,Datastore>

  • Method Details

    • name

      Datastore.Builder name(String name)

      The name of the data store.

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

    • storage

      Datastore.Builder storage(DatastoreStorage storage)

      Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.

      Parameters:
      storage - Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storage

      default Datastore.Builder storage(Consumer<DatastoreStorage.Builder> storage)

      Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.

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

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

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

    • arn

      Datastore.Builder arn(String arn)

      The ARN of the data store.

      Parameters:
      arn - The ARN of the data store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Datastore.Builder status(String status)

      The status of a data store:

      CREATING

      The data store is being created.

      ACTIVE

      The data store has been created and can be used.

      DELETING

      The data store is being deleted.

      Parameters:
      status - The status of a data store:

      CREATING

      The data store is being created.

      ACTIVE

      The data store has been created and can be used.

      DELETING

      The data store is being deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Datastore.Builder status(DatastoreStatus status)

      The status of a data store:

      CREATING

      The data store is being created.

      ACTIVE

      The data store has been created and can be used.

      DELETING

      The data store is being deleted.

      Parameters:
      status - The status of a data store:

      CREATING

      The data store is being created.

      ACTIVE

      The data store has been created and can be used.

      DELETING

      The data store is being deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • retentionPeriod

      Datastore.Builder retentionPeriod(RetentionPeriod retentionPeriod)

      How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

      Parameters:
      retentionPeriod - How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionPeriod

      default Datastore.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)

      How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

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

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

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

    • creationTime

      Datastore.Builder creationTime(Instant creationTime)

      When the data store was created.

      Parameters:
      creationTime - When the data store was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateTime

      Datastore.Builder lastUpdateTime(Instant lastUpdateTime)

      The last time the data store was updated.

      Parameters:
      lastUpdateTime - The last time the data store was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastMessageArrivalTime

      Datastore.Builder lastMessageArrivalTime(Instant lastMessageArrivalTime)

      The last time when a new message arrived in the data store.

      IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

      This feature only applies to messages that arrived in the data store after October 23, 2020.

      Parameters:
      lastMessageArrivalTime - The last time when a new message arrived in the data store.

      IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

      This feature only applies to messages that arrived in the data store after October 23, 2020.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileFormatConfiguration

      Datastore.Builder fileFormatConfiguration(FileFormatConfiguration fileFormatConfiguration)

      Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

      The default file format is JSON. You can specify only one format.

      You can't change the file format after you create the data store.

      Parameters:
      fileFormatConfiguration - Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

      The default file format is JSON. You can specify only one format.

      You can't change the file format after you create the data store.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileFormatConfiguration

      default Datastore.Builder fileFormatConfiguration(Consumer<FileFormatConfiguration.Builder> fileFormatConfiguration)

      Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

      The default file format is JSON. You can specify only one format.

      You can't change the file format after you create the data store.

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

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

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

    • datastorePartitions

      Datastore.Builder datastorePartitions(DatastorePartitions datastorePartitions)

      Contains information about the partition dimensions in a data store.

      Parameters:
      datastorePartitions - Contains information about the partition dimensions in a data store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datastorePartitions

      default Datastore.Builder datastorePartitions(Consumer<DatastorePartitions.Builder> datastorePartitions)

      Contains information about the partition dimensions in a data store.

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

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

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