json_DeployResponse.html 12.7 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: DeployResponse</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: DeployResponse</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_DeployResponse.html">DeployResponse</a></li>
        </ol>

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

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68 69
      <p>This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

      <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>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
85
          <td>  <span class="property-name">ansibleOutputList</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
86
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
87
          <td>  <span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
88 89 90 91 92 93
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94
          <td>  <span class="property-name">keyPair</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
95
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
96
          <td>  <span class="datatype-reference"><a href="json_KeyPair.html">KeyPair</a>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
97 98
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99
          <td>  <span class="property-description">The key pair to log in and manage a docker cluster</span>
100 101 102 103 104
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">scale</span>
</td>
105
          <td>  <span class="datatype-reference"><a href="json_ScaleRequest.html">ScaleRequest</a>
106 107 108
</span>
</td>
          <td>  <span class="property-description">The scale information if any for this deployment</span>
109 110 111 112 113 114 115 116 117
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">managerInfo</span>
</td>
          <td>  <span class="datatype-reference">map of object
</span>
</td>
          <td>  <span class="property-description">Returns manager info e.g. service status etc.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
118 119 120 121 122 123 124 125
</td>
        </tr>
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_DeployRequest.html">DeployRequest</a></h5></td>
        </tr>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
126
          <td><span class="property-name">provisionID</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
127 128
          <td><span class="datatype-reference">string
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
129
          <td><span class="property-description">The ID of the provision resources description <code>ProvisionResponse</code></span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
130 131
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
132
          <td><span class="property-name">managerType</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
133 134
          <td><span class="datatype-reference">string
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
135
          <td><span class="property-description">The type of deployment manager to be used (swarm, ansile, kubernetes)</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
136 137
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
138
          <td><span class="property-name">configurationID</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
139 140
          <td><span class="datatype-reference">string
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
141 142 143
          <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></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
144 145 146 147 148 149 150
        </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
151
          <td><span class="property-name">owner</span></td>
152
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
153
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
154
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
155 156
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
157 158
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
159 160
          <td><span class="property-name">id</span></td>
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
161 162 163 164 165 166 167
</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
168
</span></td>
169 170
          <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
171 172 173 174 175 176 177
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
178
  &quot;ansibleOutputList&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
179
  &quot;keyPair&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
180
    &quot;privateKey&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
181 182
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
183 184 185
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
186
      },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
187
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
188
    },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
189
    &quot;publicKey&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
190 191
      &quot;name&quot; : &quot;id_dsa.pub&quot;,
      &quot;type&quot; : &quot;PRIVATE&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
192 193 194
      &quot;attributes&quot; : {
        &quot;property1&quot; : &quot;domain_name:Virginia&quot;,
        &quot;property2&quot; : &quot;domain_name:Virginia&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
195
      },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
196
      &quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
197
    },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
198
    &quot;keyPairId&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
199
    &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
200
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
201 202 203
    &quot;timestamp&quot; : 1499793079011
  },
  &quot;scale&quot; : {
204 205
    &quot;scaleTargetID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;scaleTargetName&quot; : &quot;telegreen_db&quot;,
206 207 208 209
    &quot;numOfInstances&quot; : 5,
    &quot;owner&quot; : &quot;user1&quot;,
    &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
    &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
210
  },
211 212 213 214
  &quot;managerInfo&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
215
  &quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
216 217
  &quot;managerType&quot; : &quot;ansible&quot;,
  &quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
218
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
219
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
220
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
}</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>