software.amazon.awssdk.services.iotanalytics.model

Interface Dataset.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Dataset.Builder,Dataset>, SdkBuilder<Dataset.Builder,Dataset>, SdkPojo

Enclosing class:

Dataset

public static interface Dataset.Builder
extends SdkPojo, CopyableBuilder<Dataset.Builder,Dataset>

Method Summary

Modifier and Type	Method and Description
Dataset.Builder	actions(Collection<DatasetAction> actions) The DatasetAction objects that automatically create the dataset contents.
Dataset.Builder	actions(Consumer<DatasetAction.Builder>... actions) The DatasetAction objects that automatically create the dataset contents.
Dataset.Builder	actions(DatasetAction... actions) The DatasetAction objects that automatically create the dataset contents.
Dataset.Builder	arn(String arn) The ARN of the dataset.
Dataset.Builder	contentDeliveryRules(Collection<DatasetContentDeliveryRule> contentDeliveryRules) When dataset contents are created they are delivered to destinations specified here.
Dataset.Builder	contentDeliveryRules(Consumer<DatasetContentDeliveryRule.Builder>... contentDeliveryRules) When dataset contents are created they are delivered to destinations specified here.
Dataset.Builder	contentDeliveryRules(DatasetContentDeliveryRule... contentDeliveryRules) When dataset contents are created they are delivered to destinations specified here.
Dataset.Builder	creationTime(Instant creationTime) When the dataset was created.
Dataset.Builder	lastUpdateTime(Instant lastUpdateTime) The last time the dataset was updated.
Dataset.Builder	lateDataRules(Collection<LateDataRule> lateDataRules) A list of data rules that send notifications to CloudWatch, when data arrives late.
Dataset.Builder	lateDataRules(Consumer<LateDataRule.Builder>... lateDataRules) A list of data rules that send notifications to CloudWatch, when data arrives late.
Dataset.Builder	lateDataRules(LateDataRule... lateDataRules) A list of data rules that send notifications to CloudWatch, when data arrives late.
Dataset.Builder	name(String name) The name of the dataset.
default Dataset.Builder	retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod) Optional.
Dataset.Builder	retentionPeriod(RetentionPeriod retentionPeriod) Optional.
Dataset.Builder	status(DatasetStatus status) The status of the dataset.
Dataset.Builder	status(String status) The status of the dataset.
Dataset.Builder	triggers(Collection<DatasetTrigger> triggers) The DatasetTrigger objects that specify when the dataset is automatically updated.
Dataset.Builder	triggers(Consumer<DatasetTrigger.Builder>... triggers) The DatasetTrigger objects that specify when the dataset is automatically updated.
Dataset.Builder	triggers(DatasetTrigger... triggers) The DatasetTrigger objects that specify when the dataset is automatically updated.
default Dataset.Builder	versioningConfiguration(Consumer<VersioningConfiguration.Builder> versioningConfiguration) Optional.
Dataset.Builder	versioningConfiguration(VersioningConfiguration versioningConfiguration) Optional.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

Dataset.Builder name(String 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.

arn

Dataset.Builder arn(String arn)

The ARN of the dataset.

Parameters:

arn - The ARN of the dataset.

Returns:

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

actions

Dataset.Builder actions(Collection<DatasetAction> actions)

The DatasetAction objects that automatically create the dataset contents.

Parameters:

actions - The DatasetAction objects that automatically create the dataset contents.

Returns:

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

actions

Dataset.Builder actions(DatasetAction... actions)

The DatasetAction objects that automatically create the dataset contents.

Parameters:

actions - The DatasetAction objects that automatically create the dataset contents.

Returns:

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

actions

Dataset.Builder actions(Consumer<DatasetAction.Builder>... actions)

The DatasetAction objects that automatically create the dataset contents.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on DatasetAction.Builder

Returns:

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

See Also:

#actions(java.util.Collection)

triggers

Dataset.Builder triggers(Collection<DatasetTrigger> triggers)

The DatasetTrigger objects that specify when the dataset is automatically updated.

Parameters:

triggers - The DatasetTrigger objects that specify when the dataset is automatically updated.

Returns:

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

triggers

Dataset.Builder triggers(DatasetTrigger... triggers)

The DatasetTrigger objects that specify when the dataset is automatically updated.

Parameters:

triggers - The DatasetTrigger objects that specify when the dataset is automatically updated.

Returns:

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

triggers

Dataset.Builder triggers(Consumer<DatasetTrigger.Builder>... triggers)

The DatasetTrigger objects that specify when the dataset is automatically updated.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #triggers(List).

Parameters:

triggers - a consumer that will call methods on DatasetTrigger.Builder

Returns:

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

See Also:

#triggers(java.util.Collection)

contentDeliveryRules

Dataset.Builder contentDeliveryRules(Collection<DatasetContentDeliveryRule> contentDeliveryRules)

When dataset contents are created they are delivered to destinations specified here.

Parameters:

contentDeliveryRules - When dataset contents are created they are delivered to destinations specified here.

Returns:

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

contentDeliveryRules

Dataset.Builder contentDeliveryRules(DatasetContentDeliveryRule... contentDeliveryRules)

When dataset contents are created they are delivered to destinations specified here.

Parameters:

contentDeliveryRules - When dataset contents are created they are delivered to destinations specified here.

Returns:

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

contentDeliveryRules

Dataset.Builder contentDeliveryRules(Consumer<DatasetContentDeliveryRule.Builder>... contentDeliveryRules)

When dataset contents are created they are delivered to destinations specified here.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #contentDeliveryRules(List).

Parameters:

contentDeliveryRules - a consumer that will call methods on DatasetContentDeliveryRule.Builder

Returns:

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

See Also:

#contentDeliveryRules(java.util.Collection)

status

Dataset.Builder status(String status)

The status of the dataset.

Parameters:

status - The status of the dataset.

Returns:

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

See Also:

DatasetStatus, DatasetStatus

status

Dataset.Builder status(DatasetStatus status)

The status of the dataset.

Parameters:

status - The status of the dataset.

Returns:

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

See Also:

DatasetStatus, DatasetStatus

creationTime

Dataset.Builder creationTime(Instant creationTime)

When the dataset was created.

Parameters:

creationTime - When the dataset was created.

Returns:

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

lastUpdateTime

Dataset.Builder lastUpdateTime(Instant lastUpdateTime)

The last time the dataset was updated.

Parameters:

lastUpdateTime - The last time the dataset was updated.

Returns:

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

retentionPeriod

Dataset.Builder retentionPeriod(RetentionPeriod retentionPeriod)

Optional. How long, in days, message data is kept for the dataset.

Parameters:

retentionPeriod - Optional. How long, in days, message data is kept for the dataset.

Returns:

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

retentionPeriod

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

Optional. How long, in days, message data is kept for the dataset.

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:

retentionPeriod(RetentionPeriod)

versioningConfiguration

Dataset.Builder versioningConfiguration(VersioningConfiguration versioningConfiguration)

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

Parameters:

versioningConfiguration - Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

Returns:

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

versioningConfiguration

default Dataset.Builder versioningConfiguration(Consumer<VersioningConfiguration.Builder> versioningConfiguration)

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

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

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

Parameters:

versioningConfiguration - a consumer that will call methods on VersioningConfiguration.Builder

Returns:

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

See Also:

versioningConfiguration(VersioningConfiguration)

lateDataRules

Dataset.Builder lateDataRules(Collection<LateDataRule> lateDataRules)

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

Parameters:

lateDataRules - A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

Returns:

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

lateDataRules

Dataset.Builder lateDataRules(LateDataRule... lateDataRules)

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

Parameters:

lateDataRules - A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

Returns:

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

lateDataRules

Dataset.Builder lateDataRules(Consumer<LateDataRule.Builder>... lateDataRules)

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #lateDataRules(List).

Parameters:

lateDataRules - a consumer that will call methods on LateDataRule.Builder

Returns:

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

See Also:

#lateDataRules(java.util.Collection)