@Generated(value="software.amazon.awssdk:codegen") public final class DescribeAssetResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeAssetResponse.Builder,DescribeAssetResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeAssetResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
assetArn()
The ARN of the asset,
which has the following format.
|
List<AssetCompositeModel> |
assetCompositeModels()
The composite models for the asset.
|
Instant |
assetCreationDate()
The date the asset was created, in Unix epoch time.
|
String |
assetDescription()
A description for the asset.
|
List<AssetHierarchy> |
assetHierarchies()
A list of asset hierarchies that each contain a
hierarchyId. |
String |
assetId()
The ID of the asset.
|
Instant |
assetLastUpdateDate()
The date the asset was last updated, in Unix epoch time.
|
String |
assetModelId()
The ID of the asset model that was used to create the asset.
|
String |
assetName()
The name of the asset.
|
List<AssetProperty> |
assetProperties()
The list of asset properties for the asset.
|
AssetStatus |
assetStatus()
The current status of the asset, which contains a state and any error message.
|
static DescribeAssetResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAssetCompositeModels()
For responses, this returns true if the service returned a value for the AssetCompositeModels property.
|
boolean |
hasAssetHierarchies()
For responses, this returns true if the service returned a value for the AssetHierarchies property.
|
boolean |
hasAssetProperties()
For responses, this returns true if the service returned a value for the AssetProperties property.
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeAssetResponse.Builder> |
serializableBuilderClass() |
DescribeAssetResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String assetId()
The ID of the asset.
public final String assetArn()
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
public final String assetName()
The name of the asset.
public final String assetModelId()
The ID of the asset model that was used to create the asset.
public final boolean hasAssetProperties()
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.public final List<AssetProperty> assetProperties()
The list of asset properties for the asset.
This object doesn't include properties that you define in composite models. You can find composite model
properties in the assetCompositeModels object.
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 hasAssetProperties() method.
This object doesn't include properties that you define in composite models. You can find composite model
properties in the assetCompositeModels object.
public final boolean hasAssetHierarchies()
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.public final List<AssetHierarchy> assetHierarchies()
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 hasAssetHierarchies() method.
hierarchyId. A hierarchy specifies allowed
parent/child asset relationships.public final boolean hasAssetCompositeModels()
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.public final List<AssetCompositeModel> assetCompositeModels()
The composite models for the asset.
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 hasAssetCompositeModels() method.
public final Instant assetCreationDate()
The date the asset was created, in Unix epoch time.
public final Instant assetLastUpdateDate()
The date the asset was last updated, in Unix epoch time.
public final AssetStatus assetStatus()
The current status of the asset, which contains a state and any error message.
public final String assetDescription()
A description for the asset.
public DescribeAssetResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeAssetResponse.Builder,DescribeAssetResponse>toBuilder in class AwsResponsepublic static DescribeAssetResponse.Builder builder()
public static Class<? extends DescribeAssetResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.