json_ProvisionResponse.html 7.52 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
<!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_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_ProvisionResponse.html">ProvisionResponse</a></li>
        </ol>

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

67
      <p>This class represents a description of provisioned resources</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81

      <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>
82 83 84 85 86 87
        <tr>
          <td>  <span class="property-name">deployParameters</span>
</td>
          <td>  <span class="datatype-reference">array of <a href="json_DeployParameter.html">DeployParameter</a>
</span>
</td>
88
          <td>  <span class="property-description">The deploy parameters.</span>
89 90
</td>
        </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
91 92 93 94 95 96
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_ProvisionRequest.html">ProvisionRequest</a></h5></td>
        </tr>
        <tbody>
        <tr>
97 98
          <td><span class="property-name">cloudCredentialsIDs</span></td>
          <td><span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99
</span></td>
100
          <td><span class="property-description">The cloud credentials ids required to provision the cloud resources.</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101 102 103 104 105
        </tr>
        <tr>
          <td><span class="property-name">planID</span></td>
          <td><span class="datatype-reference">string
</span></td>
106
          <td><span class="property-description">The ID of the plan <code>PlanResponse</code> to provision for.</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
107 108
        </tr>
        <tr>
109 110
          <td><span class="property-name">keyPairIDs</span></td>
          <td><span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
111
</span></td>
112
          <td><span class="property-description">The key pair id for the keys to use to log in the provisioned VMs.</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113 114 115 116 117 118 119 120 121 122
        </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>
123
          <td><span class="property-description">The key-value map</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
124 125 126 127 128 129 130 131 132 133
        </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>
134 135 136 137 138 139 140 141 142
          <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">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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143 144 145 146 147 148 149
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
150
  &quot;deployParameters&quot; : [ {
151 152 153 154
    &quot;cloudCertificateName&quot; : &quot;Virginia&quot;,
    &quot;IP&quot; : &quot;52.73.245.157&quot;,
    &quot;user&quot; : &quot;vm_user&quot;,
    &quot;role&quot; : &quot;slave&quot;
155 156 157 158 159 160
  }, {
    &quot;cloudCertificateName&quot; : &quot;...&quot;,
    &quot;IP&quot; : &quot;...&quot;,
    &quot;user&quot; : &quot;...&quot;,
    &quot;role&quot; : &quot;...&quot;
  } ],
161 162 163
  &quot;cloudCredentialsIDs&quot; : [ &quot;58e3946e0fb4f562d84ba1ad&quot;, &quot;...&quot; ],
  &quot;planID&quot; : &quot;ASedsfd46b4fDFd83ba1q&quot;,
  &quot;keyPairIDs&quot; : [ &quot;ASedsfd46b4fFd344a1A&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
164 165 166 167
  &quot;keyValue&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
168 169
  &quot;owner&quot; : &quot;user1&quot;,
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
}</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>