<!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: ProvisionRequest</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: ProvisionRequest</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_json.html">JSON</a></li> <li class="dropdown"><a href="json_ProvisionRequest.html">ProvisionRequest</a></li> </ol> <h1 class="page-header">ProvisionRequest <small>Data Type</small></h1> <p>This class is a holder for the the object IDs that are required by the provisioner to request for cloud resources.</p> <dl class="dl-horizontal"> <dt>Subtypes</dt> <dd><a href="json_ProvisionResponse.html">ProvisionResponse</a></dd> </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> <td> <span class="property-name">cloudCredentialsIDs</span> </td> <td> <span class="datatype-reference">array of string </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">planID</span> </td> <td> <span class="datatype-reference">string </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">array of string </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> <tr> <td> <span class="property-name">deployerKeyPairIDs</span> </td> <td> <span class="datatype-reference">array of string </span> </td> <td> <span class="property-description"></span> </td> </tr> </tbody> <tr> <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_KeyValueHolder.html">KeyValueHolder</a></h5></td> </tr> <tbody> <tr> <td><span class="property-name">keyValue</span></td> <td><span class="datatype-reference">map of object </span></td> <td><span class="property-description">The key-value map</span></td> </tr> </tbody> <tr> <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_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-description">The owner (username) for the particular object. This value is set when the DAO saves the object based on the principal who made the call. It is created automatically. No need to set during a POST</span></td> </tr> <tr> <td><span class="property-name">id</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description">The UID of this object. This value is auto generated by the DAO when the object is saved.</span></td> </tr> <tr> <td><span class="property-name">timestamp</span></td> <td><span class="datatype-reference">number </span></td> <td><span class="property-description">The object's creation date in unix time stamp. It is created automatically. No need to set during a POST</span></td> </tr> </tbody> </table> <p class="lead">Example</p> <pre class="prettyprint language-js example">{ "cloudCredentialsIDs" : [ "58e3946e0fb4f562d84ba1ad", "..." ], "planID" : "ASedsfd46b4fDFd83ba1q", "userKeyPairIDs" : [ "ASedsfd46b4fFd344a1A", "..." ], "deployerKeyPairIDs" : [ "...", "..." ], "keyValue" : { "property1" : { }, "property2" : { } }, "owner" : "user1", "id" : "58e3946e0fb4f562d84ba1ad", "timestamp" : 1499793079011 }</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>