data.html 17.6 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
<!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 -->

  <title>drip-api: Data Types</title>

  <!-- 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>
        <a class="navbar-brand" href="index.html">drip-api: Data Types</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <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><a href="#syntax_json">JSON</a></li>
          <li><a href="#syntax_xml">XML</a></li>
          <li class="divider"></li>
          <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="dropdown"><a href="data.html">Data Types</a></li>
        </ol>

  <h1 class="page-header" id="data">Data Types</h1>

  <h3 id="syntax_json">JSON</h3>

  <table class="table table-hover data-types">
  <thead>
    <tr>
      <th align="center">type</th>
      <th align="center">description</th>
    </tr>
  </thead>
  <tbody data-link="row" class="rowlink">
79 80 81
    <tr class="clickable-row" data-href="json_AnsibleOutput.html">
      <td>  <span class="datatype-name">AnsibleOutput</span>
</td>
82 83
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
84 85 86 87 88 89
</td>
    </tr>
    <tr class="clickable-row" data-href="json_AnsibleResult.html">
      <td>  <span class="datatype-name">AnsibleResult</span>
</td>
      <td>  <span class="datatype-description"></span>
90 91 92 93 94 95
</td>
    </tr>
    <tr class="clickable-row" data-href="json_BenchmarkResult.html">
      <td>  <span class="datatype-name">BenchmarkResult</span>
</td>
      <td>  <span class="datatype-description"></span>
96 97
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
98 99 100
    <tr class="clickable-row" data-href="json_CloudCredentials.html">
      <td>  <span class="datatype-name">CloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101 102
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
103 104 105 106 107
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployParameter.html">
      <td>  <span class="datatype-name">DeployParameter</span>
</td>
108 109 110
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
111 112
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113 114
    <tr class="clickable-row" data-href="json_DeployRequest.html">
      <td>  <span class="datatype-name">DeployRequest</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
115
</td>
116 117
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
118 119
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
120 121
    <tr class="clickable-row" data-href="json_DeployResponse.html">
      <td>  <span class="datatype-name">DeployResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
122
</td>
123 124 125
      <td>  <span class="datatype-description">This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</span>
126 127 128 129 130 131
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Invocation.html">
      <td>  <span class="datatype-name">Invocation</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
132 133
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
134 135
    <tr class="clickable-row" data-href="json_Key.html">
      <td>  <span class="datatype-name">Key</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
136
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
137 138 139
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
140 141 142 143 144
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyPair.html">
      <td>  <span class="datatype-name">KeyPair</span>
</td>
145
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
146
logging in VMs.</span>
147 148 149 150 151 152
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyType.html">
      <td>  <span class="datatype-name">KeyType</span>
</td>
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
153 154
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
155 156
    <tr class="clickable-row" data-href="json_KeyValueHolder.html">
      <td>  <span class="datatype-name">KeyValueHolder</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
157
</td>
158 159
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
160 161 162 163 164 165
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ModuleArgs.html">
      <td>  <span class="datatype-name">ModuleArgs</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
166 167 168 169 170
</td>
    </tr>
    <tr class="clickable-row" data-href="json_OwnedObject.html">
      <td>  <span class="datatype-name">OwnedObject</span>
</td>
171 172
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
173 174
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
175 176
    <tr class="clickable-row" data-href="json_PlanResponse.html">
      <td>  <span class="datatype-name">PlanResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
177 178
</td>
      <td>  <span class="datatype-description">This class represents a plan generated by the planner.</span>
179 180 181 182 183
</td>
    </tr>
    <tr class="clickable-row" data-href="json_PlaybookRepresentation.html">
      <td>  <span class="datatype-name">PlaybookRepresentation</span>
</td>
184
      <td>  <span class="datatype-description">This class represents a playbook used by ansible manager to deploy software.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
185 186
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
187 188 189
    <tr class="clickable-row" data-href="json_ProvisionRequest.html">
      <td>  <span class="datatype-name">ProvisionRequest</span>
</td>
190 191
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
192 193 194 195
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionResponse.html">
      <td>  <span class="datatype-name">ProvisionResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
196
</td>
197
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
198 199 200 201 202 203
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Script.html">
      <td>  <span class="datatype-name">Script</span>
</td>
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
204 205 206 207 208 209
</td>
    </tr>
    <tr class="clickable-row" data-href="json_SysbenchCPUBenchmark.html">
      <td>  <span class="datatype-name">SysbenchCPUBenchmark</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
210 211 212 213 214
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ToscaRepresentation.html">
      <td>  <span class="datatype-name">ToscaRepresentation</span>
</td>
215
      <td>  <span class="datatype-description">This class is a representation of a TOSCA description.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
</td>
    </tr>
    <tr class="clickable-row" data-href="json_User.html">
      <td>  <span class="datatype-name">User</span>
</td>
      <td>  <span class="datatype-description">This class represents a user.</span>
</td>
    </tr>
  </tbody>
  </table>

  <h3 id="syntax_xml">XML</h3>

  <table class="table table-hover data-types">
  <caption>Default Namespace  (<a href="ns0.xsd">schema</a>)</caption>
  <thead>
    <tr>
      <th align="center">type</th>
      <th align="center">description</th>
    </tr>
  </thead>
  <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="xml_ns0_attribute.html">
      <td>  <span class="datatype-name">attribute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confScript.html">
      <td>  <span class="datatype-name">confScript</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confUserKey.html">
      <td>  <span class="datatype-name">confUserKey</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_configure.html">
      <td>  <span class="datatype-name">configure</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deploy.html">
      <td>  <span class="datatype-name">deploy</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_execute.html">
      <td>  <span class="datatype-name">execute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_loginKey0.html">
      <td>  <span class="datatype-name">loginKey0</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
278 279 280 281 282 283
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_plan.html">
      <td>  <span class="datatype-name">plan</span>
</td>
      <td>  <span class="datatype-description">This class represents a plan to be provided to the planner.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_register.html">
      <td>  <span class="datatype-name">register</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_result.html">
      <td>  <span class="datatype-name">result</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_upload.html">
      <td>  <span class="datatype-name">upload</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
      <td>  <span class="datatype-name">cloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
307 308
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
309 310 311 312 313
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
      <td>  <span class="datatype-name">deployParameter</span>
</td>
314 315 316
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
317 318
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
319 320
    <tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
      <td>  <span class="datatype-name">deployRequest</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
321
</td>
322 323
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
324 325
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
326 327
    <tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
      <td>  <span class="datatype-name">deployResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
328
</td>
329 330 331
      <td>  <span class="datatype-description">This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
332 333
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
334 335
    <tr class="clickable-row" data-href="xml_ns0_key.html">
      <td>  <span class="datatype-name">key</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
336
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
337 338 339
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
340 341
</td>
    </tr>
342 343
    <tr class="clickable-row" data-href="xml_ns0_keyType.html">
      <td>  <span class="datatype-name">keyType</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
344
</td>
345
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
346 347 348 349 350
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyPair.html">
      <td>  <span class="datatype-name">keyPair</span>
</td>
351
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
352
logging in VMs.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
353 354 355 356 357
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
      <td>  <span class="datatype-name">keyValueHolder</span>
</td>
358 359
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
360 361 362 363 364
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
      <td>  <span class="datatype-name">ownedObject</span>
</td>
365 366
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
367 368
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
369 370 371 372
    <tr class="clickable-row" data-href="xml_ns0_planResponse.html">
      <td>  <span class="datatype-name">planResponse</span>
</td>
      <td>  <span class="datatype-description">This class represents a plan generated by the planner.</span>
373 374 375 376 377
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_playbookRepresentation.html">
      <td>  <span class="datatype-name">playbookRepresentation</span>
</td>
378
      <td>  <span class="datatype-description">This class represents a playbook used by ansible manager to deploy software.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
379 380 381 382 383
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
      <td>  <span class="datatype-name">provisionRequest</span>
</td>
384 385
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
386 387 388 389
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
      <td>  <span class="datatype-name">provisionResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
390
</td>
391
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
392 393 394 395 396 397 398 399 400 401 402
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_script.html">
      <td>  <span class="datatype-name">script</span>
</td>
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_toscaRepresentation.html">
      <td>  <span class="datatype-name">toscaRepresentation</span>
</td>
403
      <td>  <span class="datatype-description">This class is a representation of a TOSCA description.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
404 405 406 407 408 409
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_user.html">
      <td>  <span class="datatype-name">user</span>
</td>
      <td>  <span class="datatype-description">This class represents a user.</span>
410 411 412 413 414
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ansibleOutput.html">
      <td>  <span class="datatype-name">ansibleOutput</span>
</td>
415 416 417 418 419 420 421 422 423 424 425 426 427 428
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_benchmarkResult.html">
      <td>  <span class="datatype-name">benchmarkResult</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_sysbenchCPUBenchmark.html">
      <td>  <span class="datatype-name">sysbenchCPUBenchmark</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
</td>
    </tr>
  </tbody>
  </table>

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