xml_ns0_provisionRequest.html 7.48 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: 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_xml.html">XML</a></li>
          <li class="dropdown"><a href="xml_ns0_provisionRequest.html">provisionRequest</a></li>
        </ol>

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

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68
      <p>This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

      <dl class="dl-horizontal">
        <dt>Namespace</dt>
        <dd>(Default)</dd>
        <dt>Schema</dt>
        <dd><a href="ns0.xsd">ns0.xsd</a></dd>
        <dt>Subtypes</dt>
        <dd><a href="xml_ns0_provisionResponse.html">provisionResponse</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">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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
107
          <td>  <span class="property-description">The cloud credentials ids required to provision the cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
125
          <td>  <span class="property-description">the deployerKeyPairIDs</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143
          <td>  <span class="property-description">The ID of the plan <code>PlanResponse</code> to provision for.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
161
          <td>  <span class="property-description">The key pair id for the keys to use to log in the provisioned VMs.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
179
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
180 181
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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
182 183 184 185 186 187 188
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-xml example">&lt;p-----&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
189
  &lt;cloudCredentialsIDs&gt;58e3946e0fb4f562d84ba1ad&lt;/cloudCredentialsIDs&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
190
  &lt;planID&gt;ASedsfd46b4fDFd83ba1q&lt;/planID&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
191
  &lt;userKeyPairIDs&gt;ASedsfd46b4fFd344a1A&lt;/userKeyPairIDs&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
192
  &lt;deployerKeyPairIDs&gt;...&lt;/deployerKeyPairIDs&gt;
193
  &lt;owner&gt;user1&lt;/owner&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
&lt;/p-----&gt;
</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>