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

Class UpdateAssetModelRequest

    • Method Detail

      • assetModelId

        public final String assetModelId()

        The ID of the asset model to update.

        Returns:
        The ID of the asset model to update.

      • assetModelName

        public final String assetModelName()

        A unique, friendly name for the asset model.

        Returns:
        A unique, friendly name for the asset model.

      • assetModelDescription

        public final String assetModelDescription()

        A description for the asset model.

        Returns:
        A description for the asset model.

      • 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 updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        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 updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

        You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

      • 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()

        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

        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:
        The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

        You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

      • 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 composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this 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 hasAssetModelCompositeModels() method.

        Returns:
        The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

      • clientToken

        public final String clientToken()

        A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

        Returns:
        A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      • 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