syntax_json.html 8.96 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: JSON</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: JSON</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 67 68 69 70 71 72 73 74 75 76
          <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="dropdown"><a href="syntax_json.html">JSON</a></li>
        </ol>

  <h1 class="page-header">JSON</h1>

  <table class="table table-hover datatypes">
  <thead>
    <tr>
      <th align="center">type</th>
      <th align="center">description</th>
    </tr>
  </thead>
  <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="json_AnsibleOutput.html">
      <td>  <span class="datatype-name">AnsibleOutput</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
77 78
      <td>  <span class="datatype-description">This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
79 80 81 82 83
</td>
    </tr>
    <tr class="clickable-row" data-href="json_AnsibleResult.html">
      <td>  <span class="datatype-name">AnsibleResult</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
84 85 86
      <td>  <span class="datatype-description">This class represents an ansible execution result. This can be used as a
archive / log of ansible executions for example how much time it took for
execution, errors etc.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
87 88 89 90 91
</td>
    </tr>
    <tr class="clickable-row" data-href="json_BenchmarkResult.html">
      <td>  <span class="datatype-name">BenchmarkResult</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
92 93
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94 95 96 97 98
</td>
    </tr>
    <tr class="clickable-row" data-href="json_CloudCredentials.html">
      <td>  <span class="datatype-name">CloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99 100
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101 102 103 104 105
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployParameter.html">
      <td>  <span class="datatype-name">DeployParameter</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
106 107 108
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
109 110 111 112 113
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployRequest.html">
      <td>  <span class="datatype-name">DeployRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
114 115
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
116 117 118 119 120
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployResponse.html">
      <td>  <span class="datatype-name">DeployResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
121 122 123
      <td>  <span class="datatype-description">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</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
124 125 126 127 128
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Key.html">
      <td>  <span class="datatype-name">Key</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
129 130 131
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
132 133 134 135 136
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyPair.html">
      <td>  <span class="datatype-name">KeyPair</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
137 138
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
logging in VMs.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
139 140 141 142 143
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyType.html">
      <td>  <span class="datatype-name">KeyType</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
144
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
145 146 147 148 149
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyValueHolder.html">
      <td>  <span class="datatype-name">KeyValueHolder</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150 151
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
152 153 154 155 156
</td>
    </tr>
    <tr class="clickable-row" data-href="json_OwnedObject.html">
      <td>  <span class="datatype-name">OwnedObject</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
157 158
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
159 160 161 162 163
</td>
    </tr>
    <tr class="clickable-row" data-href="json_PlanRequest.html">
      <td>  <span class="datatype-name">PlanRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
164
      <td>  <span class="datatype-description">This class represents a plan request sent to the planner.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
165 166 167 168 169
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionRequest.html">
      <td>  <span class="datatype-name">ProvisionRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
170 171
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
172 173 174 175 176
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionResponse.html">
      <td>  <span class="datatype-name">ProvisionResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
177
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
178 179
</td>
    </tr>
180 181
    <tr class="clickable-row" data-href="json_ScaleRequest.html">
      <td>  <span class="datatype-name">ScaleRequest</span>
182 183 184
</td>
      <td>  <span class="datatype-description">This class represents a scale request for a deployment. At the moment we only
support swarm.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
185 186 187 188 189
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Script.html">
      <td>  <span class="datatype-name">Script</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
190
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
191 192 193 194 195
</td>
    </tr>
    <tr class="clickable-row" data-href="json_User.html">
      <td>  <span class="datatype-name">User</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
196
      <td>  <span class="datatype-description">This class represents a user.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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 229 230 231 232 233
</td>
    </tr>
  </tbody>
  </table>

        <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>