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

Class DescribeAssetResponse

    • Method Detail

      • assetId

        public final String assetId()

        The ID of the asset, in UUID format.

        Returns:
        The ID of the asset, in UUID format.

      • assetArn

        public final String 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

        public final String assetName()

        The name of the asset.

        Returns:
        The name of the asset.

      • assetModelId

        public final String 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 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.

      • assetProperties

        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.

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

      • assetHierarchies

        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.

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

      • assetCompositeModels

        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.

        Returns:
        The composite models for the asset.

      • assetCreationDate

        public final Instant assetCreationDate()

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

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

      • assetLastUpdateDate

        public final Instant 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

        public final AssetStatus 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

        public final String 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 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.

      • assetCompositeModelSummaries

        public final List<AssetCompositeModelSummary> 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

        public final String assetExternalId()

        The external ID of the asset, if any.

        Returns:
        The external ID of the asset, if any.

      • 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