CreateDatasetRequest (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDatasetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` When dataset contents are created, they are delivered to destinations specified here.
`String`	`datasetName()` The name of the data set.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasActions()` Returns true if the Actions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasContentDeliveryRules()` Returns true if the ContentDeliveryRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLateDataRules()` Returns true if the LateDataRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTriggers()` Returns true if the Triggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<LateDataRule>`	`lateDataRules()` A list of data rules that send notifications to Amazon 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 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()` 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
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 data set.
    
    Returns:
    
    The name of the data set.
  - hasActions
```
public final boolean hasActions()
```
    Returns true if the Actions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - actions
```
public final 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.
    
    You can use hasActions() to see if a value was sent in this field.
    
    Returns:
    
    A list of actions that create the data set contents.
  - hasTriggers
```
public final boolean hasTriggers()
```
    Returns true if the Triggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - triggers
```
public final 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.
    
    You can use hasTriggers() to see if a value was sent in this field.
    
    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.
  - hasContentDeliveryRules
```
public final boolean hasContentDeliveryRules()
```
    Returns true if the ContentDeliveryRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasContentDeliveryRules() to see if a value was sent in this field.
    
    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 AWS IoT Analytics Data Sets in the AWS 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 AWS IoT Analytics Data Sets in the AWS 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 AWS IoT Analytics Data Sets in the AWS 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 AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Metadata which can be used to manage the data set.
  - hasLateDataRules
```
public final boolean hasLateDataRules()
```
    Returns true if the LateDataRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - lateDataRules
```
public final List<LateDataRule> lateDataRules()
```
    A list of data rules that send notifications to Amazon 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.
    
    You can use hasLateDataRules() to see if a value was sent in this field.
    
    Returns:
    
    A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
  - 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 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    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 final 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.

AWS SDK for Java API Reference - 2.16.44

Class CreateDatasetRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

datasetName

hasActions

actions

hasTriggers

triggers

hasContentDeliveryRules

contentDeliveryRules

retentionPeriod

versioningConfiguration

hasTags

tags

hasLateDataRules

lateDataRules

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields