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

Class CreateAssetModelRequest

    • Method Detail

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

        The 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 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<AssetModelHierarchyDefinition> assetModelHierarchies()

        The 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 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<AssetModelCompositeModelDefinition> assetModelCompositeModels()

        The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

        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 models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

        When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

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

      • hasTags

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

      • tags

        public final Map<String,​String> tags()

        A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources 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 hasTags() method.

        Returns:
        A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

      • assetModelId

        public final String assetModelId()

        The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

        Returns:
        The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

      • assetModelExternalId

        public final String assetModelExternalId()

        An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

        Returns:
        An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

      • 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

      • 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