mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
579 lines
21 KiB
HTML
579 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Insert - Deployment Manager v2.0.4+20210320</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Deployment Manager v2.0.4+20210320</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Deployments</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_cancel-preview">Cancel Preview</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_get-iam-policy">Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Insert</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_set-iam-policy">Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_stop">Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_test-iam-permissions">Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_update">Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Manifests</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../manifests_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../manifests_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Operations</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../operations_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../operations_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Resources</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../resources_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../resources_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Types</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../types_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Insert</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/deploymentmanager2-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a deployment and all of the resources described by the deployment manifest.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/ndev.cloudman</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>deploymentmanager2 --scope <scope> deployments insert ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><project></strong> <em>(string)</em><ul>
|
|
<li>The project ID for this request.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Deployment:
|
|
description: string
|
|
fingerprint: string
|
|
id: string
|
|
insert-time: string
|
|
manifest: string
|
|
name: string
|
|
operation:
|
|
client-operation-id: string
|
|
creation-timestamp: string
|
|
description: string
|
|
end-time: string
|
|
http-error-message: string
|
|
http-error-status-code: integer
|
|
id: string
|
|
insert-time: string
|
|
kind: string
|
|
name: string
|
|
operation-group-id: string
|
|
operation-type: string
|
|
progress: integer
|
|
region: string
|
|
self-link: string
|
|
start-time: string
|
|
status: string
|
|
status-message: string
|
|
target-id: string
|
|
target-link: string
|
|
user: string
|
|
zone: string
|
|
self-link: string
|
|
target:
|
|
config:
|
|
content: string
|
|
update:
|
|
description: string
|
|
manifest: string
|
|
update-time: string
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . description=magna</code><ul>
|
|
<li>An optional user-provided description of the deployment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>fingerprint=no</code><ul>
|
|
<li>Provides a fingerprint to use in requests to modify a deployment, such as <code>update()</code>, <code>stop()</code>, and <code>cancelPreview()</code> requests. A fingerprint is a randomly generated value that must be provided with <code>update()</code>, <code>stop()</code>, and <code>cancelPreview()</code> requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a <code>get()</code> request to a deployment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=ipsum</code><ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>insert-time=voluptua.</code><ul>
|
|
<li>Output only. Creation timestamp in RFC3339 text format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>manifest=at</code><ul>
|
|
<li>Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sanctus</code><ul>
|
|
<li>Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression <code>[a-z]([-a-z0-9]*[a-z0-9])?</code> which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>operation client-operation-id=sed</code><ul>
|
|
<li>[Output Only] The value of <code>requestId</code> if you provided it in the request. Not present otherwise.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>creation-timestamp=amet.</code><ul>
|
|
<li>[Deprecated] This field is deprecated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=takimata</code><ul>
|
|
<li>[Output Only] A textual description of the operation, which is set when the operation is created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-time=amet.</code><ul>
|
|
<li>[Output Only] The time that this operation was completed. This value is in RFC3339 text format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>http-error-message=duo</code><ul>
|
|
<li>[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as <code>NOT FOUND</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>http-error-status-code=46</code><ul>
|
|
<li>[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a <code>404</code> means the resource was not found.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=gubergren</code><ul>
|
|
<li>[Output Only] The unique identifier for the operation. This identifier is defined by the server.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>insert-time=lorem</code><ul>
|
|
<li>[Output Only] The time that this operation was requested. This value is in RFC3339 text format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=gubergren</code><ul>
|
|
<li>[Output Only] Type of the resource. Always <code>compute#operation</code> for Operation resources.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=eos</code><ul>
|
|
<li>[Output Only] Name of the operation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>operation-group-id=dolor</code><ul>
|
|
<li>[Output Only] An ID that represents a group of operations, such as when a group of operations results from a <code>bulkInsert</code> API request.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>operation-type=ea</code><ul>
|
|
<li>[Output Only] The type of operation, such as <code>insert</code>, <code>update</code>, or <code>delete</code>, and so on.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>progress=46</code><ul>
|
|
<li>[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>region=invidunt</code><ul>
|
|
<li>[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=amet</code><ul>
|
|
<li>[Output Only] Server-defined URL for the resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-time=duo</code><ul>
|
|
<li>[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status=ipsum</code><ul>
|
|
<li>[Output Only] The status of the operation, which can be one of the following: <code>PENDING</code>, <code>RUNNING</code>, or <code>DONE</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status-message=sed</code><ul>
|
|
<li>[Output Only] An optional textual description of the current status of the operation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>target-id=ut</code><ul>
|
|
<li>[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>target-link=gubergren</code><ul>
|
|
<li>[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user=rebum.</code><ul>
|
|
<li>[Output Only] User who requested the operation, for example: <code>user@example.com</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>zone=est</code></p>
|
|
<ul>
|
|
<li>[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. self-link=ipsum</code></p>
|
|
<ul>
|
|
<li>Output only. Server defined URL for the resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>target.config content=ipsum</code></p>
|
|
<ul>
|
|
<li>The contents of the file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...update description=est</code></p>
|
|
<ul>
|
|
<li>Output only. An optional user-provided description of the deployment after the current update has been applied.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>manifest=gubergren</code></p>
|
|
<ul>
|
|
<li>Output only. URL of the manifest representing the update configuration of this deployment.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. update-time=ea</code></p>
|
|
<ul>
|
|
<li>Output only. Update timestamp in RFC3339 text format.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p create-policy=string</strong></p>
|
|
<ul>
|
|
<li>Sets the policy to use for creating new resources.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p preview=boolean</strong></p>
|
|
<ul>
|
|
<li>If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the <code>update()</code> method or you can use the <code>cancelPreview()</code> method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../deployments_list" class="btn btn-neutral float-right" title="List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../deployments_get-iam-policy" class="btn btn-neutral" title="Get Iam Policy"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../deployments_get-iam-policy" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../deployments_list" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |