software.amazon.awssdk.services.iotanalytics.model

Class CreateDatasetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest

software.amazon.awssdk.services.iotanalytics.model.CreateDatasetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDatasetRequest
extends IoTAnalyticsRequest
implements ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDatasetRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<DatasetAction>	actions() A list of actions that create the dataset contents.
static CreateDatasetRequest.Builder	builder()
List<DatasetContentDeliveryRule>	contentDeliveryRules() When dataset contents are created, they are delivered to destinations specified here.
String	datasetName() The name of the dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions() For responses, this returns true if the service returned a value for the Actions property.
boolean	hasContentDeliveryRules() For responses, this returns true if the service returned a value for the ContentDeliveryRules property.
int	hashCode()
boolean	hasLateDataRules() For responses, this returns true if the service returned a value for the LateDataRules property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTriggers() For responses, this returns true if the service returned a value for the Triggers property.
List<LateDataRule>	lateDataRules() A list of data rules that send notifications to CloudWatch, when data arrives late.
RetentionPeriod	retentionPeriod() Optional.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDatasetRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Metadata which can be used to manage the dataset.
CreateDatasetRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<DatasetTrigger>	triggers() A list of triggers.
VersioningConfiguration	versioningConfiguration() Optional.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

datasetName

public final String datasetName()

The name of the dataset.

Returns:

The name of the dataset.

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

actions

public final List<DatasetAction> actions()

A list of actions that create the dataset contents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

Returns:

A list of actions that create the dataset contents.

hasTriggers

public final boolean hasTriggers()

For responses, this returns true if the service returned a value for the Triggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

triggers

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTriggers() method.

Returns:

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.

hasContentDeliveryRules

public final boolean hasContentDeliveryRules()

For responses, this returns true if the service returned a value for the ContentDeliveryRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

contentDeliveryRules

public final List<DatasetContentDeliveryRule> contentDeliveryRules()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContentDeliveryRules() method.

Returns:

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

retentionPeriod

public final 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.

Returns:

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.

versioningConfiguration

public final 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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Metadata which can be used to manage the dataset.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Metadata which can be used to manage the dataset.

hasLateDataRules

public final boolean hasLateDataRules()

For responses, this returns true if the service returned a value for the LateDataRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

lateDataRules

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLateDataRules() method.

Returns:

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

toBuilder

public CreateDatasetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

builder

public static CreateDatasetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDatasetRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo