Class AssetSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssetSummary.Builder,
AssetSummary>
Contains a summary of an asset.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the asset, which has the following format.final String
The ID of the asset model used to create this asset.static AssetSummary.Builder
builder()
final Instant
The date the asset was created, in Unix epoch time.final String
A description for the asset.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The external ID of the asset.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Hierarchies property.final List
<AssetHierarchy> A list of asset hierarchies that each contain ahierarchyId
.final String
id()
The ID of the asset, in UUID format.final Instant
The date the asset was last updated, in Unix epoch time.final String
name()
The name of the asset.static Class
<? extends AssetSummary.Builder> final AssetStatus
status()
The current status of the asset.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the asset, in UUID format.
- Returns:
- The ID of the asset, in UUID format.
-
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
The name of the asset.
- Returns:
- The name of the asset.
-
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
The date the asset was created, in Unix epoch time.
- Returns:
- The date the asset was created, in Unix epoch time.
-
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
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 theisEmpty()
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
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
A description for the asset.
- Returns:
- A description for the asset.
-
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
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 interfaceToCopyableBuilder<AssetSummary.Builder,
AssetSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-