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 data set contents.
static CreateDatasetRequest.Builder	builder()
List<DatasetContentDeliveryRule>	contentDeliveryRules() Returns the value of the ContentDeliveryRules property for this object.
String	datasetName() The name of the data set.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
RetentionPeriod	retentionPeriod() [Optional] How long, in days, message data is kept for the data set.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDatasetRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Metadata which can be used to manage the data set.
CreateDatasetRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<DatasetTrigger>	triggers() A list of triggers.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

datasetName

public String datasetName()

The name of the data set.

Returns:

The name of the data set.

actions

public List<DatasetAction> actions()

A list of actions that create the data set contents.

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

Returns:

A list of actions that create the data set contents.

triggers

public List<DatasetTrigger> triggers()

A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set'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.

Returns:

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

contentDeliveryRules

public List<DatasetContentDeliveryRule> contentDeliveryRules()

Returns the value of the ContentDeliveryRules property for this object.

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

Returns:

The value of the ContentDeliveryRules property for this object.

retentionPeriod

public RetentionPeriod retentionPeriod()

[Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.

Returns:

[Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.

tags

public List<Tag> tags()

Metadata which can be used to manage the data set.

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

Returns:

Metadata which can be used to manage the data set.

toBuilder

public CreateDatasetRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDatasetRequest.Builder,CreateDatasetRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

Returns:

a builder for type T

builder

public static CreateDatasetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.