OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_runtimeconfig1_beta1_cli/projects_configs-variables-create/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

324 lines
16 KiB
HTML
Raw Blame History

<!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-variables-create/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Configs Variables 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 Variables Create";
var mkdocs_page_input_path = "projects_configs-variables-create.md";
var mkdocs_page_url = "/google-apis-rs/google-runtimeconfig1_beta1-cli/projects_configs-variables-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 current"><a class="reference internal current" href="./">Configs Variables Create</a>
<ul class="current">
</ul>
</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"><a class="reference internal" href="../projects_configs-waiters-create/">Configs Waiters Create</a>
</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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Configs Variables 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-variables-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 variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the <a href="/deployment-manager/runtime-configurator/set-and-get-variables">Setting and Getting Data</a> documentation.</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 &lt;scope&gt; projects configs-variables-create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>The path to the RutimeConfig resource that this variable should belong to. 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>Variable:
name: string
state: string
text: string
update-time: string
value: 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 . name=amet.</code><ul>
<li>The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The <code>[PROJECT_ID]</code> must be a valid project ID, <code>[CONFIG_NAME]</code> must be a valid RuntimeConfig resource and <code>[VARIABLE_NAME]</code> follows Unix file system file path naming. The <code>[VARIABLE_NAME]</code> can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the <code>[VARIABLE_NAME]</code> itself, so <code>[VARIABLE_NAME]</code> must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match <a href="?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9]">0-9A-Za-z</a>? regular expression. The length of a <code>[VARIABLE_NAME]</code> must be less than 256 characters. Once you create a variable, you cannot change the variable name.</li>
</ul>
</li>
<li><code>state=takimata</code><ul>
<li>Output only. The current state of the variable. The variable state indicates the outcome of the <code>variables().watch</code> call and is visible through the <code>get</code> and <code>list</code> calls.</li>
</ul>
</li>
<li><code>text=amet.</code><ul>
<li>The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, <code>text: &amp;#34;my text value&amp;#34;</code>. The string must be valid UTF-8.</li>
</ul>
</li>
<li><code>update-time=duo</code><ul>
<li>Output only. The time of the last variable update. Timestamp will be UTC timestamp.</li>
</ul>
</li>
<li><code>value=ipsum</code><ul>
<li>The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of <code>value</code> or <code>text</code> can be set.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_configs-update/" class="btn btn-neutral float-left" title="Configs Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_configs-variables-delete/" class="btn btn-neutral float-right" title="Configs Variables Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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-update/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_configs-variables-delete/" style="color: #fcfcfc">Next &raquo;</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>
Reference in New Issue View Git Blame Copy Permalink