docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/secretmanager_v1.projects.secrets.versions.html b/docs/dyn/secretmanager_v1.projects.secrets.versions.html
index 05efb94..d314a98 100644
--- a/docs/dyn/secretmanager_v1.projects.secrets.versions.html
+++ b/docs/dyn/secretmanager_v1.projects.secrets.versions.html
@@ -76,36 +76,35 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#access">access(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Accesses a SecretVersion. This call returns the secret data.</p>
+<p class="firstline">Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.</p>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Destroys a SecretVersion.</p>
+<p class="firstline">Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.</p>
<p class="toc_element">
<code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Disables a SecretVersion.</p>
+<p class="firstline">Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.</p>
<p class="toc_element">
<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Enables a SecretVersion.</p>
+<p class="firstline">Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets metadata for a SecretVersion.</p>
+<p class="firstline">Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists SecretVersions. This call does not return secret</p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists SecretVersions. This call does not return secret data.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="access">access(name, x__xgafv=None)</code>
- <pre>Accesses a SecretVersion. This call returns the secret data.
-
-`projects/*/secrets/*/versions/latest` is an alias to the `latest`
-SecretVersion.
+ <pre>Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
Args:
- name: string, Required. The resource name of the SecretVersion in the format
-`projects/*/secrets/*/versions/*`. (required)
+ name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -115,26 +114,24 @@
An object of the form:
{ # Response message for SecretManagerService.AccessSecretVersion.
- "name": "A String", # The resource name of the SecretVersion in the format
- # `projects/*/secrets/*/versions/*`.
- "payload": { # A secret payload resource in the Secret Manager API. This contains the # Secret payload
- # sensitive secret payload that is associated with a SecretVersion.
+ "name": "A String", # The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`.
+ "payload": { # A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. # Secret payload
"data": "A String", # The secret data. Must be no larger than 64KiB.
},
}</pre>
</div>
<div class="method">
- <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
- <pre>Destroys a SecretVersion.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
-Sets the state of the SecretVersion to
-DESTROYED and irrevocably destroys the
-secret data.
+<div class="method">
+ <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
+ <pre>Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Args:
- name: string, Required. The resource name of the SecretVersion to destroy in the format
-`projects/*/secrets/*/versions/*`. (required)
+ name: string, Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*`. (required)
body: object, The request body.
The object takes the form of:
@@ -150,29 +147,36 @@
An object of the form:
{ # A secret version resource in the Secret Manager API.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+ "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+ "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ },
+ "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+ "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+ { # Describes the status of a user-managed replica for the SecretVersion.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+ },
+ ],
+ },
+ },
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
}</pre>
</div>
<div class="method">
<code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
- <pre>Disables a SecretVersion.
-
-Sets the state of the SecretVersion to
-DISABLED.
+ <pre>Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
Args:
- name: string, Required. The resource name of the SecretVersion to disable in the format
-`projects/*/secrets/*/versions/*`. (required)
+ name: string, Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*`. (required)
body: object, The request body.
The object takes the form of:
@@ -188,29 +192,36 @@
An object of the form:
{ # A secret version resource in the Secret Manager API.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+ "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+ "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ },
+ "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+ "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+ { # Describes the status of a user-managed replica for the SecretVersion.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+ },
+ ],
+ },
+ },
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
}</pre>
</div>
<div class="method">
<code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
- <pre>Enables a SecretVersion.
-
-Sets the state of the SecretVersion to
-ENABLED.
+ <pre>Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
Args:
- name: string, Required. The resource name of the SecretVersion to enable in the format
-`projects/*/secrets/*/versions/*`. (required)
+ name: string, Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*`. (required)
body: object, The request body.
The object takes the form of:
@@ -226,31 +237,36 @@
An object of the form:
{ # A secret version resource in the Secret Manager API.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+ "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+ "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ },
+ "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+ "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+ { # Describes the status of a user-managed replica for the SecretVersion.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+ },
+ ],
+ },
+ },
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets metadata for a SecretVersion.
-
-`projects/*/secrets/*/versions/latest` is an alias to the `latest`
-SecretVersion.
+ <pre>Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
Args:
- name: string, Required. The resource name of the SecretVersion in the format
-`projects/*/secrets/*/versions/*`.
-`projects/*/secrets/*/versions/latest` is an alias to the `latest`
-SecretVersion. (required)
+ name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -260,33 +276,38 @@
An object of the form:
{ # A secret version resource in the Secret Manager API.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+ "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+ "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ },
+ "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+ "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+ { # Describes the status of a user-managed replica for the SecretVersion.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+ },
+ ],
+ },
+ },
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists SecretVersions. This call does not return secret
-data.
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <pre>Lists SecretVersions. This call does not return secret data.
Args:
- parent: string, Required. The resource name of the Secret associated with the
-SecretVersions to list, in the format
-`projects/*/secrets/*`. (required)
- pageSize: integer, 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.
- pageToken: string, Optional. Pagination token, returned earlier via
-ListSecretVersionsResponse.next_page_token][].
+ parent: string, Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*`. (required)
+ pageToken: string, Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].
+ pageSize: integer, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -296,24 +317,33 @@
An object of the form:
{ # Response message for SecretManagerService.ListSecretVersions.
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page.
"totalSize": 42, # The total number of SecretVersions.
- "versions": [ # The list of SecretVersions sorted in reverse by
- # create_time (newest first).
+ "versions": [ # The list of SecretVersions sorted in reverse by create_time (newest first).
{ # A secret version resource in the Secret Manager API.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+ "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+ "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ },
+ "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+ "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+ { # Describes the status of a user-managed replica for the SecretVersion.
+ "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+ "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+ },
+ "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+ },
+ ],
+ },
+ },
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
},
],
- "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in
- # ListSecretVersionsRequest.page_token to retrieve the next page.
}</pre>
</div>