Package software.amazon.awssdk.services.iotsitewise.model

Class DatasetSummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.DatasetSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>

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

The summary details for the dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the dataset.
static DatasetSummary.Builder	builder()
Instant	creationDate()	The dataset creation date, in Unix epoch time.
String	description()	A description about the dataset, and its functionality.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the dataset.
Instant	lastUpdateDate()	The date the dataset was last updated, in Unix epoch time.
String	name()	The name of the dataset.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DatasetSummary.Builder>	serializableBuilderClass()
DatasetStatus	status()	The status of the dataset.
DatasetSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The ID of the dataset.

Returns:

The ID of the dataset.

arn

public final String arn()

The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

Returns:

The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

name

public final String name()

The name of the dataset.

Returns:

The name of the dataset.

description

public final String description()

A description about the dataset, and its functionality.

Returns:

A description about the dataset, and its functionality.

creationDate

public final Instant creationDate()

The dataset creation date, in Unix epoch time.

Returns:

The dataset creation date, in Unix epoch time.

lastUpdateDate

public final Instant lastUpdateDate()

The date the dataset was last updated, in Unix epoch time.

Returns:

The date the dataset was last updated, in Unix epoch time.

status

public final DatasetStatus status()

The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

Returns:

The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

toBuilder

public DatasetSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>

builder

public static DatasetSummary.Builder builder()

serializableBuilderClass

public static Class<? extends DatasetSummary.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo