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

Class DescribeDatasetResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeDatasetResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDatasetResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDatasetResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDatasetResponse.Builder	builder()
String	datasetArn()	The ARN of the dataset.
Instant	datasetCreationDate()	The dataset creation date, in Unix epoch time.
String	datasetDescription()	A description about the dataset, and its functionality.
String	datasetId()	The ID of the dataset.
Instant	datasetLastUpdateDate()	The date the dataset was last updated, in Unix epoch time.
String	datasetName()	The name of the dataset.
DatasetSource	datasetSource()	The data source for the dataset.
DatasetStatus	datasetStatus()	The status of the dataset.
String	datasetVersion()	The version of the dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDatasetResponse.Builder>	serializableBuilderClass()
DescribeDatasetResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

datasetId

public final String datasetId()

The ID of the dataset.

Returns:

The ID of the dataset.

datasetArn

public final String datasetArn()

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

datasetName

public final String datasetName()

The name of the dataset.

Returns:

The name of the dataset.

datasetDescription

public final String datasetDescription()

A description about the dataset, and its functionality.

Returns:

A description about the dataset, and its functionality.

datasetSource

public final DatasetSource datasetSource()

The data source for the dataset.

Returns:

The data source for the dataset.

datasetStatus

public final DatasetStatus datasetStatus()

The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

Returns:

The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

datasetCreationDate

public final Instant datasetCreationDate()

The dataset creation date, in Unix epoch time.

Returns:

The dataset creation date, in Unix epoch time.

datasetLastUpdateDate

public final Instant datasetLastUpdateDate()

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

Returns:

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

datasetVersion

public final String datasetVersion()

The version of the dataset.

Returns:

The version of the dataset.

toBuilder

public DescribeDatasetResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDatasetResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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