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

Class DescribeAssetModelResponse

    • Method Detail

      • assetModelId

        public final String assetModelId()

        The ID of the asset model, in UUID format.

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

      • assetModelArn

        public final String assetModelArn()

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

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

        Returns:
        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • assetModelName

        public final String assetModelName()

        The name of the asset model.

        Returns:
        The name of the asset model.

      • assetModelDescription

        public final String assetModelDescription()

        The asset model's description.

        Returns:
        The asset model's description.

      • hasAssetModelProperties

        public final boolean hasAssetModelProperties()
        For responses, this returns true if the service returned a value for the AssetModelProperties 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.

      • assetModelProperties

        public final List<AssetModelProperty> assetModelProperties()

        The list of asset properties for the asset model.

        This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels 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 hasAssetModelProperties() method.

        Returns:
        The list of asset properties for the asset model.

        This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

      • hasAssetModelHierarchies

        public final boolean hasAssetModelHierarchies()
        For responses, this returns true if the service returned a value for the AssetModelHierarchies 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.

      • assetModelHierarchies

        public final List<AssetModelHierarchy> assetModelHierarchies()

        A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

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

        Returns:
        A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

      • hasAssetModelCompositeModels

        public final boolean hasAssetModelCompositeModels()
        For responses, this returns true if the service returned a value for the AssetModelCompositeModels 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.

      • assetModelCompositeModels

        public final List<AssetModelCompositeModel> assetModelCompositeModels()

        The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

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

        Returns:
        The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

      • assetModelCreationDate

        public final Instant assetModelCreationDate()

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

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

      • assetModelLastUpdateDate

        public final Instant assetModelLastUpdateDate()

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

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

      • assetModelStatus

        public final AssetModelStatus assetModelStatus()

        The current status of the asset model, which contains a state and any error message.

        Returns:
        The current status of the asset model, which contains a state and any error message.

      • assetModelType

        public final AssetModelType assetModelType()

        The type of asset model.

        • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

        • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

        If the service returns an enum value that is not available in the current SDK version, assetModelType will return AssetModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assetModelTypeAsString().

        Returns:
        The type of asset model.

        • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

        • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

        See Also:
        AssetModelType

      • assetModelTypeAsString

        public final String assetModelTypeAsString()

        The type of asset model.

        • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

        • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

        If the service returns an enum value that is not available in the current SDK version, assetModelType will return AssetModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assetModelTypeAsString().

        Returns:
        The type of asset model.

        • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

        • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

        See Also:
        AssetModelType

      • hasAssetModelCompositeModelSummaries

        public final boolean hasAssetModelCompositeModelSummaries()
        For responses, this returns true if the service returned a value for the AssetModelCompositeModelSummaries 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.

      • assetModelCompositeModelSummaries

        public final List<AssetModelCompositeModelSummary> assetModelCompositeModelSummaries()

        The list of the immediate child custom composite model summaries for the asset model.

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

        Returns:
        The list of the immediate child custom composite model summaries for the asset model.

      • assetModelExternalId

        public final String assetModelExternalId()

        The external ID of the asset model, if any.

        Returns:
        The external ID of the asset model, 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