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

Class CreateAssetModelCompositeModelRequest

    • Method Detail

      • assetModelId

        public final String assetModelId()

        The ID of the asset model this composite model is a part of.

        Returns:
        The ID of the asset model this composite model is a part of.

      • parentAssetModelCompositeModelId

        public final String parentAssetModelCompositeModelId()

        The ID of the parent composite model in this asset model relationship.

        Returns:
        The ID of the parent composite model in this asset model relationship.

      • assetModelCompositeModelExternalId

        public final String assetModelCompositeModelExternalId()

        An external ID to assign to the composite model.

        If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

        Returns:
        An external ID to assign to the composite model.

        If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

      • assetModelCompositeModelId

        public final String assetModelCompositeModelId()

        The ID of the composite model. 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 of the composite model. 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.

      • assetModelCompositeModelDescription

        public final String assetModelCompositeModelDescription()

        A description for the composite model.

        Returns:
        A description for the composite model.

      • assetModelCompositeModelName

        public final String assetModelCompositeModelName()

        A unique name for the composite model.

        Returns:
        A unique name for the composite model.

      • assetModelCompositeModelType

        public final String assetModelCompositeModelType()

        The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

        Returns:
        The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

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

      • composedAssetModelId

        public final String composedAssetModelId()

        The ID of a component model which is reused to create this composite model.

        Returns:
        The ID of a component model which is reused to create this composite model.

      • hasAssetModelCompositeModelProperties

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

      • assetModelCompositeModelProperties

        public final List<AssetModelPropertyDefinition> assetModelCompositeModelProperties()

        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

        You can specify up to 200 properties per composite 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 hasAssetModelCompositeModelProperties() method.

        Returns:
        The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

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

      • 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