mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Update documentation
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href="." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -184,7 +184,7 @@ capabilities. Errors will be printed to standard error, and cause the program's
|
||||
|
||||
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/secretmanager1-cli">on github</a>.</p>
|
||||
<h1 id="usage">Usage</h1>
|
||||
<p>This documentation was generated from the <em>Secret Manager</em> API at revision <em>20210319</em>. The CLI is at version <em>2.0.4</em>.</p>
|
||||
<p>This documentation was generated from the <em>Secret Manager</em> API at revision <em>20220226</em>. The CLI is at version <em>3.0.0</em>.</p>
|
||||
<pre><code class="bash">secretmanager1 [options]
|
||||
projects
|
||||
locations-get <name> [-p <v>]... [-o <out>]
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations Get - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Locations Get - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Locations List - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Locations List - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -221,7 +221,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p page-size=integer</strong></p>
|
||||
<ul>
|
||||
<li>The maximum number of results to return. If not set, the service will select a default.</li>
|
||||
<li>The maximum number of results to return. If not set, the service selects a default.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Add Version - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Add Version - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -205,6 +205,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<pre><code>AddSecretVersionRequest:
|
||||
payload:
|
||||
data: string
|
||||
data-crc32c: string
|
||||
|
||||
</code></pre>
|
||||
|
||||
@@ -214,6 +215,10 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>The secret data. Must be no larger than 64KiB.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>data-crc32c=magna</code><ul>
|
||||
<li>Optional. If specified, SecretManagerService will verify the integrity of the received data on SecretManagerService.AddSecretVersion calls using the crc32c checksum and store it to include in future SecretManagerService.AccessSecretVersion responses. If a checksum is not provided in the SecretManagerService.AddSecretVersion request, the SecretManagerService will generate and store one for you. The CRC32C value is encoded as a Int64 for compatibility, and can be safely downconverted to uint32 in languages that support this type. https://cloud.google.com/apis/design/design_patterns#integer_types</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Create - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Create - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -207,6 +207,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>Secret:
|
||||
create-time: string
|
||||
etag: string
|
||||
expire-time: string
|
||||
labels: { string: string }
|
||||
name: string
|
||||
@@ -223,37 +224,41 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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=magna</code><ul>
|
||||
<li><code>-r . create-time=no</code><ul>
|
||||
<li>Output only. The time at which the Secret was created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>expire-time=no</code><ul>
|
||||
<li><code>etag=ipsum</code><ul>
|
||||
<li>Optional. Etag of the currently stored Secret.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>expire-time=voluptua.</code><ul>
|
||||
<li>Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>labels=key=ipsum</code><ul>
|
||||
<li><code>labels=key=at</code><ul>
|
||||
<li>The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: <code>\p{Ll}\p{Lo}{0,62}</code> Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: <code>[\p{Ll}\p{Lo}\p{N}_-]{0,63}</code> No more than 64 labels can be assigned to a given resource.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=voluptua.</code><ul>
|
||||
<li><code>name=sanctus</code><ul>
|
||||
<li>Output only. The resource name of the Secret in the format <code>projects/*/secrets/*</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>replication.automatic.customer-managed-encryption kms-key-name=at</code></p>
|
||||
<p><code>replication.automatic.customer-managed-encryption kms-key-name=sed</code></p>
|
||||
<ul>
|
||||
<li>Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in <code>global</code>. The expected format is <code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>....rotation next-rotation-time=sanctus</code></p>
|
||||
<p><code>....rotation next-rotation-time=amet.</code></p>
|
||||
<ul>
|
||||
<li>Optional. Timestamp in UTC at which the Secret is scheduled to rotate. next_rotation_time MUST be set if rotation_period is set.</li>
|
||||
<li>Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>rotation-period=sed</code></p>
|
||||
<p><code>rotation-period=takimata</code></p>
|
||||
<ul>
|
||||
<li>Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Delete - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Delete - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -78,6 +78,9 @@
|
||||
<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>
|
||||
|
||||
|
||||
@@ -204,6 +207,16 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
</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 etag=string</strong><ul>
|
||||
<li>Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Get Iam Policy - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Get Iam Policy - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -213,7 +213,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<code>-p</code> for completeness.</p>
|
||||
<ul>
|
||||
<li><strong>-p options-requested-policy-version=integer</strong><ul>
|
||||
<li>Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</li>
|
||||
<li>Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Get - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Get - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets List - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets List - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -213,6 +213,12 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<code>-p</code> for completeness.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>-p filter=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional. Filter string, adhering to the rules in <a href="https://cloud.google.com/secret-manager/docs/filtering">List-operation filtering</a>. List only secrets matching the filter. If filter is empty, all secrets are listed.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p page-size=integer</strong></p>
|
||||
<ul>
|
||||
<li>Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.</li>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Patch - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Patch - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -207,6 +207,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>Secret:
|
||||
create-time: string
|
||||
etag: string
|
||||
expire-time: string
|
||||
labels: { string: string }
|
||||
name: string
|
||||
@@ -223,43 +224,47 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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=takimata</code><ul>
|
||||
<li><code>-r . create-time=duo</code><ul>
|
||||
<li>Output only. The time at which the Secret was created.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>expire-time=amet.</code><ul>
|
||||
<li><code>etag=ipsum</code><ul>
|
||||
<li>Optional. Etag of the currently stored Secret.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>expire-time=gubergren</code><ul>
|
||||
<li>Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>labels=key=duo</code><ul>
|
||||
<li><code>labels=key=lorem</code><ul>
|
||||
<li>The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: <code>\p{Ll}\p{Lo}{0,62}</code> Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: <code>[\p{Ll}\p{Lo}\p{N}_-]{0,63}</code> No more than 64 labels can be assigned to a given resource.</li>
|
||||
<li>the value will be associated with the given <code>key</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>name=ipsum</code><ul>
|
||||
<li><code>name=gubergren</code><ul>
|
||||
<li>Output only. The resource name of the Secret in the format <code>projects/*/secrets/*</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>replication.automatic.customer-managed-encryption kms-key-name=gubergren</code></p>
|
||||
<p><code>replication.automatic.customer-managed-encryption kms-key-name=eos</code></p>
|
||||
<ul>
|
||||
<li>Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the same location as the replica location. For secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must reside in <code>global</code>. The expected format is <code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>....rotation next-rotation-time=lorem</code></p>
|
||||
<p><code>....rotation next-rotation-time=dolor</code></p>
|
||||
<ul>
|
||||
<li>Optional. Timestamp in UTC at which the Secret is scheduled to rotate. next_rotation_time MUST be set if rotation_period is set.</li>
|
||||
<li>Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>rotation-period=gubergren</code></p>
|
||||
<p><code>rotation-period=ea</code></p>
|
||||
<ul>
|
||||
<li>Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. ttl=eos</code></p>
|
||||
<p><code>.. ttl=ipsum</code></p>
|
||||
<ul>
|
||||
<li>Input only. The TTL for the Secret.</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Set Iam Policy - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Set Iam Policy - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -212,18 +212,18 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 .policy etag=dolor</code><ul>
|
||||
<li><code>-r .policy etag=invidunt</code><ul>
|
||||
<li><code>etag</code> is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the <code>etag</code> in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An <code>etag</code> is returned in the response to <code>getIamPolicy</code>, and systems are expected to put that etag in the request to <code>setIamPolicy</code> to ensure that their change will be applied to the same version of the policy. <strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>version=84</code></p>
|
||||
<p><code>version=54</code></p>
|
||||
<ul>
|
||||
<li>Specifies the format of the policy. Valid values are <code>0</code>, <code>1</code>, and <code>3</code>. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version <code>3</code>. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions <strong>Important:</strong> If you use IAM Conditions, you must include the <code>etag</code> field whenever you call <code>setIamPolicy</code>. If you omit this field, then IAM allows you to overwrite a version <code>3</code> policy with a version <code>1</code> policy, and all of the conditions in the version <code>3</code> policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. update-mask=ipsum</code></p>
|
||||
<p><code>.. update-mask=duo</code></p>
|
||||
<ul>
|
||||
<li>OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: <code>paths: &#34;bindings, etag&#34;</code></li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Test Iam Permissions - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Test Iam Permissions - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -209,7 +209,7 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
|
||||
<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 . permissions=invidunt</code><ul>
|
||||
<li><code>-r . permissions=ipsum</code><ul>
|
||||
<li>The set of permissions to check for the <code>resource</code>. Permissions with wildcards (such as '<em>' or 'storage.</em>') are not allowed. For more information see <a href="https://cloud.google.com/iam/docs/overview#permissions">IAM Overview</a>.</li>
|
||||
<li>Each invocation of this argument appends the given value to the array.</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions Access - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions Access - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -181,7 +181,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Accesses a SecretVersion. This call returns the secret data. <code>projects/*/secrets/*/versions/latest</code> is an alias to the <code>latest</code> SecretVersion.</p>
|
||||
<p>Accesses a SecretVersion. This call returns the secret data. <code>projects/*/secrets/*/versions/latest</code> is an alias to the most recently created SecretVersion.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
||||
@@ -189,7 +189,7 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The resource name of the SecretVersion in the format <code>projects/*/secrets/*/versions/*</code>.</li>
|
||||
<li>Required. The resource name of the SecretVersion in the format <code>projects/*/secrets/*/versions/*</code>. <code>projects/*/secrets/*/versions/latest</code> is an alias to the most recently created SecretVersion.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions Destroy - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions Destroy - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -203,10 +203,17 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
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>DestroySecretVersionRequest:
|
||||
etag: 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 . etag=sed</code><ul>
|
||||
<li>Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions Disable - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions Disable - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -203,10 +203,17 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
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>DisableSecretVersionRequest:
|
||||
etag: 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 . etag=ut</code><ul>
|
||||
<li>Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions Enable - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions Enable - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -203,10 +203,17 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
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>EnableSecretVersionRequest:
|
||||
etag: 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 . etag=gubergren</code><ul>
|
||||
<li>Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.</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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions Get - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions Get - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -181,7 +181,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>Gets metadata for a SecretVersion. <code>projects/*/secrets/*/versions/latest</code> is an alias to the <code>latest</code> SecretVersion.</p>
|
||||
<p>Gets metadata for a SecretVersion. <code>projects/*/secrets/*/versions/latest</code> is an alias to the most recently created SecretVersion.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
||||
@@ -189,7 +189,7 @@ You can set the scope for this method like this: <code>secretmanager1 --scope &l
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The resource name of the SecretVersion in the format <code>projects/*/secrets/*/versions/*</code>. <code>projects/*/secrets/*/versions/latest</code> is an alias to the <code>latest</code> SecretVersion.</li>
|
||||
<li>Required. The resource name of the SecretVersion in the format <code>projects/*/secrets/*/versions/*</code>. <code>projects/*/secrets/*/versions/latest</code> is an alias to the most recently created SecretVersion.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Secrets Versions List - Secret Manager v2.0.4+20210319</title>
|
||||
<title>Secrets Versions List - Secret Manager v3.0.0+20220226</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Secret Manager v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Secret Manager v3.0.0+20220226</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -213,6 +213,12 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<code>-p</code> for completeness.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>-p filter=string</strong></p>
|
||||
<ul>
|
||||
<li>Optional. Filter string, adhering to the rules in <a href="https://cloud.google.com/secret-manager/docs/filtering">List-operation filtering</a>. List only secret versions matching the filter. If filter is empty, all secret versions are listed.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p page-size=integer</strong></p>
|
||||
<ul>
|
||||
<li>Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.</li>
|
||||
|
||||
Reference in New Issue
Block a user