Class DescribeAssetResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAssetResponse.Builder,
DescribeAssetResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
assetArn()
The ARN of the asset, which has the following format.final List
<AssetCompositeModel> The composite models for the asset.final List
<AssetCompositeModelSummary> The list of the immediate child custom composite model summaries for the asset.final Instant
The date the asset was created, in Unix epoch time.final String
A description for the asset.final String
The external ID of the asset, if any.final List
<AssetHierarchy> A list of asset hierarchies that each contain ahierarchyId
.final String
assetId()
The ID of the asset, in UUID format.final Instant
The date the asset was last updated, in Unix epoch time.final String
The ID of the asset model that was used to create the asset.final String
The name of the asset.final List
<AssetProperty> The list of asset properties for the asset.final AssetStatus
The current status of the asset, which contains a state and any error message.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the AssetCompositeModels property.final boolean
For responses, this returns true if the service returned a value for the AssetCompositeModelSummaries property.final boolean
For responses, this returns true if the service returned a value for the AssetHierarchies property.final boolean
For responses, this returns true if the service returned a value for the AssetProperties property.final int
hashCode()
static Class
<? extends DescribeAssetResponse.Builder> 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 class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
assetId
The ID of the asset, in UUID format.
- Returns:
- The ID of the asset, in UUID format.
-
assetArn
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}
-
assetName
The name of the asset.
- Returns:
- The name of the asset.
-
assetModelId
The ID of the asset model that was used to create the asset.
- Returns:
- The ID of the asset model that was used to create the asset.
-
hasAssetProperties
public final boolean hasAssetProperties()For responses, this returns true if the service returned a value for the AssetProperties 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. -
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.- Returns:
- 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.
-
hasAssetHierarchies
public final boolean hasAssetHierarchies()For responses, this returns true if the service returned a value for the AssetHierarchies 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. -
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.- Returns:
- A list of asset hierarchies that each contain a
hierarchyId
. A hierarchy specifies allowed parent/child asset relationships.
-
hasAssetCompositeModels
public final boolean hasAssetCompositeModels()For responses, this returns true if the service returned a value for the AssetCompositeModels 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. -
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.- Returns:
- The composite models for the asset.
-
assetCreationDate
The date the asset was created, in Unix epoch time.
- Returns:
- The date the asset was created, in Unix epoch time.
-
assetLastUpdateDate
The date the asset was last updated, in Unix epoch time.
- Returns:
- The date the asset was last updated, in Unix epoch time.
-
assetStatus
The current status of the asset, which contains a state and any error message.
- Returns:
- The current status of the asset, which contains a state and any error message.
-
assetDescription
A description for the asset.
- Returns:
- A description for the asset.
-
hasAssetCompositeModelSummaries
public final boolean hasAssetCompositeModelSummaries()For responses, this returns true if the service returned a value for the AssetCompositeModelSummaries 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. -
assetCompositeModelSummaries
The list of the immediate child custom composite model summaries 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
hasAssetCompositeModelSummaries()
method.- Returns:
- The list of the immediate child custom composite model summaries for the asset.
-
assetExternalId
The external ID of the asset, if any.
- Returns:
- The external ID of the asset, if any.
-
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<DescribeAssetResponse.Builder,
DescribeAssetResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-