<!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: XML</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: XML</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 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="syntax_xml.html">XML</a></li> </ol> <h1 class="page-header">XML</h1> <table class="table table-hover datatypes"> <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> </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> </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> <td> <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner to request for resources.</span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_deployParameter.html"> <td> <span class="datatype-name">deployParameter</span> </td> <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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_deployRequest.html"> <td> <span class="datatype-name">deployRequest</span> </td> <td> <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a software</span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_deployResponse.html"> <td> <span class="datatype-name">deployResponse</span> </td> <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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_key.html"> <td> <span class="datatype-name">key</span> </td> <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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_keyPair.html"> <td> <span class="datatype-name">keyPair</span> </td> <td> <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for logging in VMs.</span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html"> <td> <span class="datatype-name">keyValueHolder</span> </td> <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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_monitorringMessage.html"> <td> <span class="datatype-name">monitorringMessage</span> </td> <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_ownedObject.html"> <td> <span class="datatype-name">ownedObject</span> </td> <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_provisionRequest.html"> <td> <span class="datatype-name">provisionRequest</span> </td> <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> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_provisionResponse.html"> <td> <span class="datatype-name">provisionResponse</span> </td> <td> <span class="datatype-description">This class represents a description of provisioned resources</span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_scaleRequest.html"> <td> <span class="datatype-name">scaleRequest</span> </td> <td> <span class="datatype-description">This class represents a scale request for a deployment. At the moment we only support swarm.</span> </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_user.html"> <td> <span class="datatype-name">user</span> </td> <td> <span class="datatype-description">This class represents a user.</span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_ansibleOutput.html"> <td> <span class="datatype-name">ansibleOutput</span> </td> <td> <span class="datatype-description">This class represents the the ansible out put for a specific VM. This can be used as a archive / log of ansible executions</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">This is the base class for users to own resources. Many classes extend this class</span> </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>