json_DeployRequest.html 6.65 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8
<!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 -->

Spiros Koulouzis's avatar
Spiros Koulouzis committed
9
  <title>drip-api: DeployRequest</title>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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

  <!-- 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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
38
        <a class="navbar-brand" href="index.html">drip-api: DeployRequest</a>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
39 40 41
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
42
          <li><a href="resources.html">Resources</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
          <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_DeployRequest.html">DeployRequest</a></li>
        </ol>

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

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68
      <p>This class holds the necessary POJO IDs to request the deployment of a
software</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

      <dl class="dl-horizontal">
        <dt>Subtypes</dt>
        <dd><a href="json_DeployResponse.html">DeployResponse</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
86
          <td>  <span class="property-name">provisionID</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
87 88 89 90
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
91
          <td>  <span class="property-description">The ID of the provision resources description <code>ProvisionResponse</code></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
92 93 94
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
95
          <td>  <span class="property-name">managerType</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
96 97 98 99
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
100
          <td>  <span class="property-description">The type of deployment manager to be used (swarm, ansile, kubernetes)</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101 102 103
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
104
          <td>  <span class="property-name">configurationID</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
105 106 107 108
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
109 110 111
          <td>  <span class="property-description">The ID of the configuration POJO that contains information used the
chosen deployment manager (for now only ansible)
<code>PlaybookRepresentation</code></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
112 113 114 115 116 117 118 119
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
120
          <td><span class="property-name">owner</span></td>
121
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
122
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
123
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
124 125
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
126 127
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
128 129
          <td><span class="property-name">id</span></td>
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
130 131 132 133 134 135 136
</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
Spiros Koulouzis's avatar
Spiros Koulouzis committed
137
</span></td>
138 139
          <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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
140 141 142 143 144 145 146
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
147
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
148 149
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
151
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
152
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
}</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>