xml_ns0_deployResponse.html 9.33 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: deployResponse</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: deployResponse</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_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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

      <dl class="dl-horizontal">
        <dt>Namespace</dt>
        <dd>(Default)</dd>
        <dt>Schema</dt>
        <dd><a href="ns0.xsd">ns0.xsd</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">ansibleOutputList</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
106
          <td>  <span class="property-description">the ansibleOutputList</span>
107 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">managerInfo</span>
</td>
          <td>  <span class="datatype-reference">(custom)
</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>
          <td>  <span class="property-description">Returns manager info e.g. service status etc.</span>
125 126 127 128 129
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">scale</span>
</td>
130
          <td>  <span class="datatype-reference"><a href="xml_ns0_scaleRequest.html">scaleRequest</a>
131 132 133 134 135 136 137 138 139 140 141 142
</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>
          <td>  <span class="property-description">The scale information if any for this deployment</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
</td>
        </tr>
        </tbody>
        <tr>
          <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_deployRequest.html">deployRequest</a></h5></td>
        </tr>
        <tbody>
        <tr>
          <td><span class="property-name">configurationID</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
160 161 162
          <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
163 164 165 166 167 168 169 170 171 172 173
        </tr>
        <tr>
          <td><span class="property-name">managerType</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
174
          <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
175 176 177 178 179 180 181 182 183 184 185
        </tr>
        <tr>
          <td><span class="property-name">provisionID</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
186
          <td><span class="property-description">The ID of the provision resources description <code>ProvisionResponse</code></span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
        </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
203
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
204 205
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
206 207 208 209 210 211 212 213
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-xml example">&lt;d-----&gt;
  &lt;ansibleOutputList&gt;...&lt;/ansibleOutputList&gt;
214
  &lt;scale&gt;
215 216
    &lt;scaleTargetID&gt;58e3946e0fb4f562d84ba1ad&lt;/scaleTargetID&gt;
    &lt;scaleTargetName&gt;telegreen_db&lt;/scaleTargetName&gt;
217 218 219
    &lt;numOfInstances&gt;5&lt;/numOfInstances&gt;
    &lt;owner&gt;user1&lt;/owner&gt;
  &lt;/scale&gt;
220
  &lt;managerInfo&gt;{&quot;services_info&quot;: {&quot;status&quot;: &quot;Ready&quot;, &quot;hostname&quot;: &quot;stoor74&quot;, &quot;ID&quot;: &quot;v5y8cs7zd5atej53buq86g8j7&quot;, &quot;availability&quot;: &quot;Active&quot;}, .&quot;cluster_node_info&quot;: {&quot;status&quot;: &quot;Ready&quot;, &quot;hostname&quot;: &quot;stoor74&quot;, &quot;ID&quot;: &quot;v5y8cs7zd5atej53buq86g8j7&quot;, &quot;availability&quot;: &quot;Active&quot;}}&lt;/managerInfo&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
221
  &lt;provisionID&gt;58e3946e0fb4f562d84ba1ad&lt;/provisionID&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
222
  &lt;managerType&gt;ansible&lt;/managerType&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
223
  &lt;configurationID&gt;58e3946e0fb4f562d84ba1ad&lt;/configurationID&gt;
224
  &lt;owner&gt;user1&lt;/owner&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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 255 256 257 258 259
&lt;/d-----&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>