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

Class AssetSummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.AssetSummary

All Implemented Interfaces:

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

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

Contains a summary of an asset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the asset, which has the following format.
String	assetModelId()	The ID of the asset model used to create this asset.
static AssetSummary.Builder	builder()
Instant	creationDate()	The date the asset was created, in Unix epoch time.
String	description()	A description for the asset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	The external ID of the asset.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHierarchies()	For responses, this returns true if the service returned a value for the Hierarchies property.
List<AssetHierarchy>	hierarchies()	A list of asset hierarchies that each contain a hierarchyId.
String	id()	The ID of the asset, in UUID format.
Instant	lastUpdateDate()	The date the asset was last updated, in Unix epoch time.
String	name()	The name of the asset.
List<SdkField<?>>	sdkFields()
static Class<? extends AssetSummary.Builder>	serializableBuilderClass()
AssetStatus	status()	The current status of the asset.
AssetSummary.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 asset, in UUID format.

Returns:

The ID of the asset, in UUID format.

arn

public final String arn()

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

Returns:

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

name

public final String name()

The name of the asset.

Returns:

The name of the asset.

assetModelId

public final String assetModelId()

The ID of the asset model used to create this asset.

Returns:

The ID of the asset model used to create this asset.

creationDate

public final Instant creationDate()

The date the asset was created, in Unix epoch time.

Returns:

The date the asset was created, in Unix epoch time.

lastUpdateDate

public final Instant lastUpdateDate()

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

Returns:

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

status

public final AssetStatus status()

The current status of the asset.

Returns:

The current status of the asset.

hasHierarchies

public final boolean hasHierarchies()

For responses, this returns true if the service returned a value for the Hierarchies 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.

hierarchies

public final List<AssetHierarchy> hierarchies()

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

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 hasHierarchies() method.

Returns:

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

description

public final String description()

A description for the asset.

Returns:

A description for the asset.

externalId

public final String externalId()

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

toBuilder

public AssetSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetSummary.Builder,AssetSummary>

builder

public static AssetSummary.Builder builder()

serializableBuilderClass

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