json_PlanRequest.html 5.85 KB
Newer Older
1 2 3 4 5 6 7 8
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

Spiros Koulouzis's avatar
Spiros Koulouzis committed
9
  <title>drip-api: PlanRequest</title>
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
38
        <a class="navbar-brand" href="index.html">drip-api: PlanRequest</a>
39 40 41
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
42
          <li><a href="resources.html">Resources</a></li>
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_PlanRequest.html">PlanRequest</a></li>
        </ol>

      <h1 class="page-header">PlanRequest <small>Data Type</small></h1>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67
      <p>This class represents a plan request sent to the planner.</p>
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

      <dl class="dl-horizontal">
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
83
          <td>  <span class="property-name">toscaID</span>
84 85 86 87
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
88
          <td>  <span class="property-description">The ID of the tosca file the generated this plan</span>
89 90 91
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
92
          <td>  <span class="property-name">managerType</span>
93 94 95 96
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
97
          <td>  <span class="property-description">The type of cluster manager</span>
98 99 100
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101
          <td>  <span class="property-name">vmUserName</span>
102 103 104 105
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
106
          <td>  <span class="property-description">The default username to be set to all VMs</span>
107 108 109
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
110
          <td>  <span class="property-name">cloudProvider</span>
111 112 113 114
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
115
          <td>  <span class="property-description">The cloud provider</span>
116 117 118
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
119
          <td>  <span class="property-name">osType</span>
120 121 122 123
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
124
          <td>  <span class="property-description">The type of OS for the VMs</span>
125 126 127
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
128
          <td>  <span class="property-name">domain</span>
129 130 131 132
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
133
          <td>  <span class="property-description">The domain to request the VMs</span>
134 135 136 137 138 139 140 141
</td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
142
  &quot;toscaID&quot; : &quot;592d5884e452f1b9b666a657&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143 144
  &quot;managerType&quot; : &quot;swarm&quot;,
  &quot;vmUserName&quot; : &quot;vm_user&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
145
  &quot;cloudProvider&quot; : &quot;egi&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
146 147
  &quot;osType&quot; : &quot;Ubuntu16.04&quot;,
  &quot;domain&quot; : &quot;us-east-1&quot;
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
}</pre>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>