mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
366 lines
17 KiB
HTML
366 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" 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.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-runtimeconfig1_beta1-cli/projects_configs-waiters-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Configs Waiters Create - Cloud RuntimeConfig v5.0.4+20240227</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Configs Waiters Create";
|
|
var mkdocs_page_input_path = "projects_configs-waiters-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-runtimeconfig1_beta1-cli/projects_configs-waiters-create/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</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-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloud RuntimeConfig v5.0.4+20240227
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-create/">Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-delete/">Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-get/">Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-get-iam-policy/">Configs Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-list/">Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-operations-get/">Configs Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-operations-test-iam-permissions/">Configs Operations Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-set-iam-policy/">Configs Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-test-iam-permissions/">Configs Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-update/">Configs Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-create/">Configs Variables Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-delete/">Configs Variables Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-get/">Configs Variables Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-list/">Configs Variables List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-test-iam-permissions/">Configs Variables Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-update/">Configs Variables Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-variables-watch/">Configs Variables Watch</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Configs Waiters Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-waiters-delete/">Configs Waiters Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-waiters-get/">Configs Waiters Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-waiters-list/">Configs Waiters List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_configs-waiters-test-iam-permissions/">Configs Waiters Test Iam Permissions</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Cloud RuntimeConfig v5.0.4+20240227</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=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Configs Waiters Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/runtimeconfig1_beta1-cli/edit/master/docs/projects_configs-waiters-create.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.</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/cloudruntimeconfig</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>runtimeconfig1-beta1 --scope <scope> projects configs-waiters-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: <code>projects/[PROJECT_ID]/configs/[CONFIG_NAME]</code>.</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>Waiter:
|
|
create-time: string
|
|
done: boolean
|
|
error:
|
|
code: integer
|
|
message: string
|
|
failure:
|
|
cardinality:
|
|
number: integer
|
|
path: string
|
|
name: string
|
|
success:
|
|
cardinality:
|
|
number: integer
|
|
path: string
|
|
timeout: 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 . create-time=invidunt</code><ul>
|
|
<li>Output only. The instant at which this Waiter resource was created. Adding the value of <code>timeout</code> to this instant yields the timeout deadline for the waiter.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>done=true</code><ul>
|
|
<li>Output only. If the value is <code>false</code>, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, <code>error</code> will be set.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>error code=81</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=ipsum</code></p>
|
|
<ul>
|
|
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..failure.cardinality number=8</code></p>
|
|
<ul>
|
|
<li>The number variables under the <code>path</code> that must exist to meet this condition. Defaults to 1 if not specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>path=ut</code></p>
|
|
<ul>
|
|
<li>The root of the variable subtree to monitor. For example, <code>/foo</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... name=gubergren</code></p>
|
|
<ul>
|
|
<li>The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The <code>[PROJECT_ID]</code> must be a valid Google Cloud project ID, the <code>[CONFIG_NAME]</code> must be a valid RuntimeConfig resource, the <code>[WAITER_NAME]</code> must match RFC 1035 segment specification, and the length of <code>[WAITER_NAME]</code> must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>success.cardinality number=85</code><ul>
|
|
<li>The number variables under the <code>path</code> that must exist to meet this condition. Defaults to 1 if not specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>path=est</code></p>
|
|
<ul>
|
|
<li>The root of the variable subtree to monitor. For example, <code>/foo</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... timeout=ipsum</code></p>
|
|
<ul>
|
|
<li>[Required] Specifies the timeout of the waiter in seconds, beginning from the instant that <code>waiters().create</code> method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the <code>error</code> code to <code>DEADLINE_EXCEEDED</code>.</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><strong>-p request-id=string</strong><ul>
|
|
<li>An optional but recommended unique <code>request_id</code>. If the server receives two <code>create()</code> requests with the same <code>request_id</code>, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty <code>request_id</code> fields are ignored. It is responsibility of the client to ensure uniqueness of the <code>request_id</code> strings. <code>request_id</code> strings are limited to 64 characters.</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="../projects_configs-variables-watch/" class="btn btn-neutral float-left" title="Configs Variables Watch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_configs-waiters-delete/" class="btn btn-neutral float-right" title="Configs Waiters Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/runtimeconfig1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_configs-variables-watch/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_configs-waiters-delete/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|