Dataset (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.iotanalytics.model.Dataset

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Dataset.Builder,Dataset>

@Generated(value="software.amazon.awssdk:codegen")
public final class Dataset
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Dataset.Builder,Dataset>

Information about a data set.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Dataset.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DatasetAction>`	`actions()` The `DatasetAction` objects that automatically create the data set contents.
`String`	`arn()` The ARN of the data set.
`static Dataset.Builder`	`builder()`
`List<DatasetContentDeliveryRule>`	`contentDeliveryRules()` When dataset contents are created they are delivered to destinations specified here.
`Instant`	`creationTime()` When the data set was created.
`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)`
`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`	`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).
`Instant`	`lastUpdateTime()` The last time the data set was updated.
`List<LateDataRule>`	`lateDataRules()` A list of data rules that send notifications to Amazon CloudWatch, when data arrives late.
`String`	`name()` The name of the data set.
`RetentionPeriod`	`retentionPeriod()` Optional.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Dataset.Builder>`	`serializableBuilderClass()`
`DatasetStatus`	`status()` The status of the data set.
`String`	`statusAsString()` The status of the data set.
`Dataset.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()` The `DatasetTrigger` objects that specify when the data set is automatically updated.
`VersioningConfiguration`	`versioningConfiguration()` Optional.

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
  - name
```
public final String name()
```
    The name of the data set.
    
    Returns:
    
    The name of the data set.
  - arn
```
public final String arn()
```
    The ARN of the data set.
    
    Returns:
    
    The ARN 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()
```
    The DatasetAction objects that automatically 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:
    
    The DatasetAction objects that automatically 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()
```
    The DatasetTrigger objects that specify when the data set is automatically updated.
    
    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:
    
    The DatasetTrigger objects that specify when the data set is automatically updated.
  - 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.
  - status
```
public final DatasetStatus status()
```
    The status of the data set.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the data set.
    
    See Also:
    
    DatasetStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the data set.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the data set.
    
    See Also:
    
    DatasetStatus
  - creationTime
```
public final Instant creationTime()
```
    When the data set was created.
    
    Returns:
    
    When the data set was created.
  - lastUpdateTime
```
public final Instant lastUpdateTime()
```
    The last time the data set was updated.
    
    Returns:
    
    The last time the data set was updated.
  - retentionPeriod
```
public final RetentionPeriod retentionPeriod()
```
    Optional. How long, in days, message data is kept for the data set.
    
    Returns:
    
    Optional. How long, in days, message data is kept for the data set.
  - 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.
  - 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 Dataset.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<Dataset.Builder,Dataset>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Dataset.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Dataset.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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.41

Class Dataset

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

hasActions

actions

hasTriggers

triggers

hasContentDeliveryRules

contentDeliveryRules

status

statusAsString

creationTime

lastUpdateTime

retentionPeriod

versioningConfiguration

hasLateDataRules

lateDataRules

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields