aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/acm-participant-guide.rst
diff options
context:
space:
mode:
authorrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-06-08 16:54:55 +0100
committerrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-06-12 10:17:15 +0100
commit580de3ad1abeac9001d5f5190e12dd687fa7d0fc (patch)
tree94a56bc56721ccf3ddae8146efe87e8ed77255de /docs/clamp/acm/acm-participant-guide.rst
parentd3ea2362501e3b51a709f8e2671f97ec5aad1349 (diff)
Add documentation for AC instance update support
Issue-ID: POLICY-4698 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I80396650e0f12636ea39de924777bc0ef78dc920
Diffstat (limited to 'docs/clamp/acm/acm-participant-guide.rst')
-rw-r--r--docs/clamp/acm/acm-participant-guide.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/clamp/acm/acm-participant-guide.rst b/docs/clamp/acm/acm-participant-guide.rst
index 0b576d6f..dfd81778 100644
--- a/docs/clamp/acm/acm-participant-guide.rst
+++ b/docs/clamp/acm/acm-participant-guide.rst
@@ -75,7 +75,7 @@ AutomationCompositionElementListener:
Every participant should implement a handler class that implements the AutomationCompositionElementListener interface
from the Participant Intermediary. The intermediary listener class listens for the incoming events from the ACM-runtime
and invoke the handler class implementations for various operations. This class implements the methods for deploying,
- undeploying, locking, unlocking , getting UseState, getting OperationalState requests that are coming from the ACM-runtime.
+ undeploying, locking, unlocking , updating, getting UseState, getting OperationalState requests that are coming from the ACM-runtime.
The methods are as follows.
.. code-block:: bash
@@ -84,6 +84,7 @@ AutomationCompositionElementListener:
2. void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties) throws PfModelException;
3. default void lock(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
4. default void unlock(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException;
+ 5. default void update(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties) throws PfModelException;
These method from the interface are implemented independently as per the user requirement. These methods after handling the
appropriate requests should also invoke the intermediary's publisher apis to notify the ACM-runtime with the acknowledgement events.