gerrit.onap Code Review - ccsdk/sli.git/blob

   1 package org.opendaylight.yang.gen.v1.org.onap.ccsdk.sli.core.sliapi.rev161110;
   2 import org.opendaylight.yangtools.yang.binding.RpcService;
   3 import org.opendaylight.yangtools.yang.common.RpcResult;
   4 import java.util.concurrent.Future;
   5
   6 /**
   7  * Interface for implementing the following YANG RPCs defined in module <b>SLI-API</b>
   8  * <pre>
   9  * rpc healthcheck {
  10  *     input {
  11  *     }
  12  *
  13  *     output {
  14  *         leaf response-code {
  15  *             type string;
  16  *         }
  17  *         leaf ack-final-indicator {
  18  *             type string;
  19  *         }
  20  *         leaf response-message {
  21  *             type string;
  22  *         }
  23  *         leaf context-memory-json {
  24  *             type string;
  25  *         }
  26  *     }
  27  * }
  28  * rpc execute-graph {
  29  *     " Method to add a new parameter.";
  30  *     input {
  31  *         leaf module-name {
  32  *             type string;
  33  *         }
  34  *         leaf rpc-name {
  35  *             type string;
  36  *         }
  37  *         leaf mode {
  38  *             type enumeration;
  39  *         }
  40  *         list sli-parameter {
  41  *             key "parameter-name"
  42  *             leaf parameter-name {
  43  *                 type string;
  44  *             }
  45  *             leaf int-value {
  46  *                 type int32;
  47  *             }
  48  *             leaf string-value {
  49  *                 type string;
  50  *             }
  51  *             leaf boolean-value {
  52  *                 type boolean;
  53  *             }
  54  *             uses parameter-setting;
  55  *         }
  56  *     }
  57  *
  58  *     output {
  59  *         leaf response-code {
  60  *             type string;
  61  *         }
  62  *         leaf ack-final-indicator {
  63  *             type string;
  64  *         }
  65  *         leaf response-message {
  66  *             type string;
  67  *         }
  68  *         leaf context-memory-json {
  69  *             type string;
  70  *         }
  71  *     }
  72  * }
  73  * </pre>
  74  *
  75  */
  76 public interface SLIAPIService
  77     extends
  78     RpcService
  79 {
  80
  81
  82
  83
  84     Future<RpcResult<HealthcheckOutput>> healthcheck();
  85
  86     /**
  87      * Method to add a new parameter.
  88      *
  89      */
  90     Future<RpcResult<ExecuteGraphOutput>> executeGraph(ExecuteGraphInput input);
  91
  92 }
  93