Dataset (AWS Java SDK :: Services :: IoTAnalytics 2.20.133 API)

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

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 dataset contents.
`String`	`arn()` The ARN of the dataset.
`static Dataset.Builder`	`builder()`
`List<DatasetContentDeliveryRule>`	`contentDeliveryRules()` When dataset contents are created they are delivered to destinations specified here.
`Instant`	`creationTime()` When the dataset was created.
`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`	`hasTriggers()` For responses, this returns true if the service returned a value for the Triggers property.
`Instant`	`lastUpdateTime()` The last time the dataset was updated.
`List<LateDataRule>`	`lateDataRules()` A list of data rules that send notifications to CloudWatch, when data arrives late.
`String`	`name()` The name of the dataset.
`RetentionPeriod`	`retentionPeriod()` Optional.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Dataset.Builder>`	`serializableBuilderClass()`
`DatasetStatus`	`status()` The status of the dataset.
`String`	`statusAsString()` The status of the dataset.
`Dataset.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<DatasetTrigger>`	`triggers()` The `DatasetTrigger` objects that specify when the dataset is automatically updated.
`VersioningConfiguration`	`versioningConfiguration()` Optional.

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
  - name
```
public final String name()
```
    The name of the dataset.
    
    Returns:
    
    The name of the dataset.
  - arn
```
public final String arn()
```
    The ARN of the dataset.
    
    Returns:
    
    The ARN 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()
```
    The DatasetAction objects that automatically 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:
    
    The DatasetAction objects that automatically 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()
```
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    
    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:
    
    The DatasetTrigger objects that specify when the dataset is automatically updated.
  - 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.
  - status
```
public final DatasetStatus status()
```
    The status of the dataset.
    
    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 dataset.
    
    See Also:
    
    DatasetStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the dataset.
    
    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 dataset.
    
    See Also:
    
    DatasetStatus
  - creationTime
```
public final Instant creationTime()
```
    When the dataset was created.
    
    Returns:
    
    When the dataset was created.
  - lastUpdateTime
```
public final Instant lastUpdateTime()
```
    The last time the dataset was updated.
    
    Returns:
    
    The last time the dataset was updated.
  - retentionPeriod
```
public final RetentionPeriod retentionPeriod()
```
    Optional. How long, in days, message data is kept for the dataset.
    
    Returns:
    
    Optional. How long, in days, message data is kept for the dataset.
  - 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.
  - 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 Dataset.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Dataset.Builder,Dataset>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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