Interface CreateDatasetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>, IoTAnalyticsRequest.Builder, SdkBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDatasetRequest

@Mutable
@NotThreadSafe
public static interface CreateDatasetRequest.Builder
extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Method Summary

Modifier and Type	Method	Description
CreateDatasetRequest.Builder	actions(Collection<DatasetAction> actions)	A list of actions that create the dataset contents.
CreateDatasetRequest.Builder	actions(Consumer<DatasetAction.Builder>... actions)	A list of actions that create the dataset contents.
CreateDatasetRequest.Builder	actions(DatasetAction... actions)	A list of actions that create the dataset contents.
CreateDatasetRequest.Builder	contentDeliveryRules(Collection<DatasetContentDeliveryRule> contentDeliveryRules)	When dataset contents are created, they are delivered to destinations specified here.
CreateDatasetRequest.Builder	contentDeliveryRules(Consumer<DatasetContentDeliveryRule.Builder>... contentDeliveryRules)	When dataset contents are created, they are delivered to destinations specified here.
CreateDatasetRequest.Builder	contentDeliveryRules(DatasetContentDeliveryRule... contentDeliveryRules)	When dataset contents are created, they are delivered to destinations specified here.
CreateDatasetRequest.Builder	datasetName(String datasetName)	The name of the dataset.
CreateDatasetRequest.Builder	lateDataRules(Collection<LateDataRule> lateDataRules)	A list of data rules that send notifications to CloudWatch, when data arrives late.
CreateDatasetRequest.Builder	lateDataRules(Consumer<LateDataRule.Builder>... lateDataRules)	A list of data rules that send notifications to CloudWatch, when data arrives late.
CreateDatasetRequest.Builder	lateDataRules(LateDataRule... lateDataRules)	A list of data rules that send notifications to CloudWatch, when data arrives late.
CreateDatasetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDatasetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateDatasetRequest.Builder	retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)	Optional.
CreateDatasetRequest.Builder	retentionPeriod(RetentionPeriod retentionPeriod)	Optional.
CreateDatasetRequest.Builder	tags(Collection<Tag> tags)	Metadata which can be used to manage the dataset.
CreateDatasetRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Metadata which can be used to manage the dataset.
CreateDatasetRequest.Builder	tags(Tag... tags)	Metadata which can be used to manage the dataset.
CreateDatasetRequest.Builder	triggers(Collection<DatasetTrigger> triggers)	A list of triggers.
CreateDatasetRequest.Builder	triggers(Consumer<DatasetTrigger.Builder>... triggers)	A list of triggers.
CreateDatasetRequest.Builder	triggers(DatasetTrigger... triggers)	A list of triggers.
default CreateDatasetRequest.Builder	versioningConfiguration(Consumer<VersioningConfiguration.Builder> versioningConfiguration)	Optional.
CreateDatasetRequest.Builder	versioningConfiguration(VersioningConfiguration versioningConfiguration)	Optional.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

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.

actions

CreateDatasetRequest.Builder actions(Collection<DatasetAction> actions)

A list of actions that create the dataset contents.

Parameters:

actions - A list of actions that create the dataset contents.

Returns:

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

actions

CreateDatasetRequest.Builder actions(DatasetAction... actions)

A list of actions that create the dataset contents.

Parameters:

actions - A list of actions that create the dataset contents.

Returns:

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

actions

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

A list of actions that 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<DatasetAction>).

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<DatasetAction>)

triggers

CreateDatasetRequest.Builder triggers(Collection<DatasetTrigger> triggers)

A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

Parameters:

triggers - A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

Returns:

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

triggers

CreateDatasetRequest.Builder triggers(DatasetTrigger... triggers)

A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

Parameters:

triggers - A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

Returns:

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

triggers

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

A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

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<DatasetTrigger>).

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<DatasetTrigger>)

contentDeliveryRules

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

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

CreateDatasetRequest.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<DatasetContentDeliveryRule>).

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<DatasetContentDeliveryRule>)

retentionPeriod

CreateDatasetRequest.Builder retentionPeriod(RetentionPeriod retentionPeriod)

Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

Parameters:

retentionPeriod - Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration 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.

retentionPeriod

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

Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration 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 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

CreateDatasetRequest.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 CreateDatasetRequest.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)

tags

CreateDatasetRequest.Builder tags(Collection<Tag> tags)

Metadata which can be used to manage the dataset.

Parameters:

tags - Metadata which can be used to manage the dataset.

Returns:

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

tags

CreateDatasetRequest.Builder tags(Tag... tags)

Metadata which can be used to manage the dataset.

Parameters:

tags - Metadata which can be used to manage the dataset.

Returns:

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

tags

CreateDatasetRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata which can be used to manage the dataset.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

lateDataRules

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

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

CreateDatasetRequest.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<LateDataRule>).

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<LateDataRule>)

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.