<!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: provisionResponse</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: provisionResponse</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="active dropdown"><a href="syntax_xml.html">XML</a></li> <li class="dropdown"><a href="xml_ns0_provisionResponse.html">provisionResponse</a></li> </ol> <h1 class="page-header">provisionResponse <small>Data Type</small></h1> <p>This class represents a description of provisioned resources</p> <dl class="dl-horizontal"> <dt>Namespace</dt> <dd>(Default)</dd> <dt>Schema</dt> <dd><a href="ns0.xsd">ns0.xsd</a></dd> </dl> <table class="table datatype-properties"> <caption>Properties</caption> <thead> <tr> <th>name</th> <th>data type</th> <th>type</th> <th>namespace</th> <th>min/max occurs</th> <th>description</th> </tr> </thead> <tbody> <tr> <td> <span class="property-name">cloudKeyPairIDs</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/unbounded </span> </td> <td> <span class="property-description">the cloudKeyPairIDs</span> </td> </tr> <tr> <td> <span class="property-name">deployParameters</span> </td> <td> <span class="datatype-reference"><a href="xml_ns0_deployParameter.html">deployParameter</a> </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/unbounded </span> </td> <td> <span class="property-description">The deploy parameters.</span> </td> </tr> </tbody> <tr> <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_provisionRequest.html">provisionRequest</a></h5></td> </tr> <tbody> <tr> <td><span class="property-name">cloudCredentialsIDs</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/unbounded </span></td> <td><span class="property-description">The cloud credentials ids required to provision the cloud resources.</span></td> </tr> <tr> <td><span class="property-name">deployerKeyPairIDs</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/unbounded </span></td> <td><span class="property-description">the deployerKeyPairIDs</span></td> </tr> <tr> <td><span class="property-name">planID</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">The ID of the plan <code>PlanResponse</code> to provision for.</span></td> </tr> <tr> <td><span class="property-name">userKeyPairIDs</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/unbounded </span></td> <td><span class="property-description">The key pair id for the keys to use to log in the provisioned VMs.</span></td> </tr> </tbody> <tr> <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_ownedObject.html">ownedObject</a></h5></td> </tr> <tbody> <tr> <td><span class="property-name">owner</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">The owner (username) for the particular object. This value is set when the DAO saves the object based on the principal how made the call</span></td> </tr> <tr> <td><span class="property-name">timestamp</span></td> <td><span class="datatype-reference">long </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">The object's creation date in unix time stamp</span></td> </tr> </tbody> </table> <p class="lead">Example</p> <pre class="prettyprint language-xml example"><p-----> <deployParameters> <IP>52.73.245.157</IP> <user>vm_user</user> <role>slave</role> </deployParameters> <cloudKeyPairIDs>...</cloudKeyPairIDs> <cloudCredentialsIDs>58e3946e0fb4f562d84ba1ad</cloudCredentialsIDs> <planID>ASedsfd46b4fDFd83ba1q</planID> <userKeyPairIDs>ASedsfd46b4fFd344a1A</userKeyPairIDs> <deployerKeyPairIDs>...</deployerKeyPairIDs> </p-----> </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>