syntax_json.html 9.74 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 67 68 69 70 71 72 73
<!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: JSON</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: JSON</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="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">
74 75 76
    <tr class="clickable-row" data-href="json_AnsibleOutput.html">
      <td>  <span class="datatype-name">AnsibleOutput</span>
</td>
77 78
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
79 80 81 82 83 84 85 86 87 88 89 90
</td>
    </tr>
    <tr class="clickable-row" data-href="json_AnsibleResult.html">
      <td>  <span class="datatype-name">AnsibleResult</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_AnsibleResult_.html">
      <td>  <span class="datatype-name">AnsibleResult_</span>
</td>
      <td>  <span class="datatype-description"></span>
91 92 93 94 95 96
</td>
    </tr>
    <tr class="clickable-row" data-href="json_BenchmarkResult.html">
      <td>  <span class="datatype-name">BenchmarkResult</span>
</td>
      <td>  <span class="datatype-description"></span>
97 98
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99 100 101
    <tr class="clickable-row" data-href="json_CloudCredentials.html">
      <td>  <span class="datatype-name">CloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102 103
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
104 105 106 107 108
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployParameter.html">
      <td>  <span class="datatype-name">DeployParameter</span>
</td>
109 110 111
      <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
112 113
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
114 115
    <tr class="clickable-row" data-href="json_DeployRequest.html">
      <td>  <span class="datatype-name">DeployRequest</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
116
</td>
117 118
      <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
119 120
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
121 122
    <tr class="clickable-row" data-href="json_DeployResponse.html">
      <td>  <span class="datatype-name">DeployResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
123
</td>
124 125 126
      <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>
127 128 129 130 131 132
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Invocation.html">
      <td>  <span class="datatype-name">Invocation</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
133 134
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
135 136
    <tr class="clickable-row" data-href="json_Key.html">
      <td>  <span class="datatype-name">Key</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
137
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
138 139 140
      <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>
141 142 143 144 145
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyPair.html">
      <td>  <span class="datatype-name">KeyPair</span>
</td>
146
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
147
logging in VMs.</span>
148 149 150 151 152 153
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyType.html">
      <td>  <span class="datatype-name">KeyType</span>
</td>
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
154 155
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
156 157
    <tr class="clickable-row" data-href="json_KeyValueHolder.html">
      <td>  <span class="datatype-name">KeyValueHolder</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
158
</td>
159 160
      <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>
161 162 163 164 165 166
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ModuleArgs.html">
      <td>  <span class="datatype-name">ModuleArgs</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
167 168 169 170 171
</td>
    </tr>
    <tr class="clickable-row" data-href="json_OwnedObject.html">
      <td>  <span class="datatype-name">OwnedObject</span>
</td>
172 173
      <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
174 175
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
176 177
    <tr class="clickable-row" data-href="json_PlanResponse.html">
      <td>  <span class="datatype-name">PlanResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
178 179
</td>
      <td>  <span class="datatype-description">This class represents a plan generated by the planner.</span>
180 181 182 183 184
</td>
    </tr>
    <tr class="clickable-row" data-href="json_PlaybookRepresentation.html">
      <td>  <span class="datatype-name">PlaybookRepresentation</span>
</td>
185
      <td>  <span class="datatype-description">This class represents a playbook used by ansible manager to deploy software.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
186 187
</td>
    </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
188 189 190
    <tr class="clickable-row" data-href="json_ProvisionRequest.html">
      <td>  <span class="datatype-name">ProvisionRequest</span>
</td>
191 192
      <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
193 194 195 196
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionResponse.html">
      <td>  <span class="datatype-name">ProvisionResponse</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
197
</td>
198
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
199 200 201 202 203 204
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Script.html">
      <td>  <span class="datatype-name">Script</span>
</td>
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
205 206 207 208 209 210
</td>
    </tr>
    <tr class="clickable-row" data-href="json_SysbenchCPUBenchmark.html">
      <td>  <span class="datatype-name">SysbenchCPUBenchmark</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
211 212 213 214 215
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ToscaRepresentation.html">
      <td>  <span class="datatype-name">ToscaRepresentation</span>
</td>
216
      <td>  <span class="datatype-description">This class is a representation of a TOSCA description.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
217 218 219 220 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 255 256 257 258 259
</td>
    </tr>
    <tr class="clickable-row" data-href="json_User.html">
      <td>  <span class="datatype-name">User</span>
</td>
      <td>  <span class="datatype-description">This class represents a user.</span>
</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>