Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 26aa9e282e30ca9c8797ee5346cbe9c0b9ca65a7 / . / docs / dyn / secretmanager_v1.projects.secrets.versions.html
blob: 5e1fa3458ef3444b637e1ffe8fcb1d0cd950e019 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="secretmanager_v1.html">Secret Manager API</a> . <a href="secretmanager_v1.projects.html">projects</a> . <a href="secretmanager_v1.projects.secrets.html">secrets</a> . <a href="secretmanager_v1.projects.secrets.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#access">access(name, x__xgafv=None)</a></code></p>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]79<p class="firstline">Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]94<p class="firstline">Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Lists SecretVersions. This call does not return secret data.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="access">access(name, x__xgafv=None)</code>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]104 <pre>Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105
106Args:
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]107 name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # Response message for SecretManagerService.AccessSecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]117 &quot;name&quot;: &quot;A String&quot;, # The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`.
118 &quot;payload&quot;: { # A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. # Secret payload
119 &quot;data&quot;: &quot;A String&quot;, # The secret data. Must be no larger than 64KiB.
120 },
121}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122</div>
123
124<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 <code class="details" id="close">close()</code>
126 <pre>Close httplib2 connections.</pre>
127</div>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129<div class="method">
130 <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
131 <pre>Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132
133Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134 name: string, Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 body: object, The request body.
136 The object takes the form of:
137
138{ # Request message for SecretManagerService.DestroySecretVersion.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]139 &quot;etag&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]140}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147Returns:
148 An object of the form:
149
150 { # A secret version resource in the Secret Manager API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]151 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
152 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]153 &quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of the currently stored SecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 &quot;name&quot;: &quot;A String&quot;, # 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.
155 &quot;replicationStatus&quot;: { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
156 &quot;automatic&quot;: { # 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.
157 &quot;customerManagedEncryption&quot;: { # 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.
158 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]159 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]161 &quot;userManaged&quot;: { # 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.
162 &quot;replicas&quot;: [ # Output only. The list of replica statuses for the SecretVersion.
163 { # Describes the status of a user-managed replica for the SecretVersion.
164 &quot;customerManagedEncryption&quot;: { # 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.
165 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
166 },
167 &quot;location&quot;: &quot;A String&quot;, # Output only. The canonical ID of the replica location. For example: `&quot;us-east1&quot;`.
168 },
169 ],
170 },
171 },
172 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
173}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174</div>
175
176<div class="method">
177 <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 <pre>Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179
180Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181 name: string, Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 body: object, The request body.
183 The object takes the form of:
184
185{ # Request message for SecretManagerService.DisableSecretVersion.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]186 &quot;etag&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]187}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188
189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
193
194Returns:
195 An object of the form:
196
197 { # A secret version resource in the Secret Manager API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]198 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
199 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]200 &quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of the currently stored SecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]201 &quot;name&quot;: &quot;A String&quot;, # 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.
202 &quot;replicationStatus&quot;: { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
203 &quot;automatic&quot;: { # 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.
204 &quot;customerManagedEncryption&quot;: { # 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.
205 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]206 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]207 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]208 &quot;userManaged&quot;: { # 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.
209 &quot;replicas&quot;: [ # Output only. The list of replica statuses for the SecretVersion.
210 { # Describes the status of a user-managed replica for the SecretVersion.
211 &quot;customerManagedEncryption&quot;: { # 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.
212 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
213 },
214 &quot;location&quot;: &quot;A String&quot;, # Output only. The canonical ID of the replica location. For example: `&quot;us-east1&quot;`.
215 },
216 ],
217 },
218 },
219 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
220}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221</div>
222
223<div class="method">
224 <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]225 <pre>Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226
227Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]228 name: string, Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 body: object, The request body.
230 The object takes the form of:
231
232{ # Request message for SecretManagerService.EnableSecretVersion.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]233 &quot;etag&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]234}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241Returns:
242 An object of the form:
243
244 { # A secret version resource in the Secret Manager API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
246 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]247 &quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of the currently stored SecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]248 &quot;name&quot;: &quot;A String&quot;, # 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.
249 &quot;replicationStatus&quot;: { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
250 &quot;automatic&quot;: { # 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.
251 &quot;customerManagedEncryption&quot;: { # 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.
252 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]253 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]254 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]255 &quot;userManaged&quot;: { # 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.
256 &quot;replicas&quot;: [ # Output only. The list of replica statuses for the SecretVersion.
257 { # Describes the status of a user-managed replica for the SecretVersion.
258 &quot;customerManagedEncryption&quot;: { # 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.
259 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
260 },
261 &quot;location&quot;: &quot;A String&quot;, # Output only. The canonical ID of the replica location. For example: `&quot;us-east1&quot;`.
262 },
263 ],
264 },
265 },
266 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
267}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268</div>
269
270<div class="method">
271 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]272 <pre>Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]273
274Args:
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame]275 name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281Returns:
282 An object of the form:
283
284 { # A secret version resource in the Secret Manager API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]285 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
286 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]287 &quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of the currently stored SecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]288 &quot;name&quot;: &quot;A String&quot;, # 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.
289 &quot;replicationStatus&quot;: { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
290 &quot;automatic&quot;: { # 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.
291 &quot;customerManagedEncryption&quot;: { # 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.
292 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]293 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]294 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]295 &quot;userManaged&quot;: { # 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.
296 &quot;replicas&quot;: [ # Output only. The list of replica statuses for the SecretVersion.
297 { # Describes the status of a user-managed replica for the SecretVersion.
298 &quot;customerManagedEncryption&quot;: { # 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.
299 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
300 },
301 &quot;location&quot;: &quot;A String&quot;, # Output only. The canonical ID of the replica location. For example: `&quot;us-east1&quot;`.
302 },
303 ],
304 },
305 },
306 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
307}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308</div>
309
310<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]311 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]312 <pre>Lists SecretVersions. This call does not return secret data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313
314Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]315 parent: string, Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*`. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]316 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]317 pageToken: string, Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323Returns:
324 An object of the form:
325
326 { # Response message for SecretManagerService.ListSecretVersions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]327 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page.
328 &quot;totalSize&quot;: 42, # The total number of SecretVersions.
329 &quot;versions&quot;: [ # The list of SecretVersions sorted in reverse by create_time (newest first).
330 { # A secret version resource in the Secret Manager API.
331 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
332 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
yoshi-code-bot27f691d2021-05-10 04:12:02 -0700[diff] [blame]333 &quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of the currently stored SecretVersion.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]334 &quot;name&quot;: &quot;A String&quot;, # 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.
335 &quot;replicationStatus&quot;: { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
336 &quot;automatic&quot;: { # 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.
337 &quot;customerManagedEncryption&quot;: { # 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.
338 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]339 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]340 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]341 &quot;userManaged&quot;: { # 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.
342 &quot;replicas&quot;: [ # Output only. The list of replica statuses for the SecretVersion.
343 { # Describes the status of a user-managed replica for the SecretVersion.
344 &quot;customerManagedEncryption&quot;: { # 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.
345 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
346 },
347 &quot;location&quot;: &quot;A String&quot;, # Output only. The canonical ID of the replica location. For example: `&quot;us-east1&quot;`.
348 },
349 ],
350 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]352 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
353 },
354 ],
355}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]356</div>
357
358<div class="method">
359 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
360 <pre>Retrieves the next page of results.
361
362Args:
363 previous_request: The request for the previous page. (required)
364 previous_response: The response from the request for the previous page. (required)
365
366Returns:
367 A request object that you can call &#x27;execute()&#x27; on to request the next
368 page. Returns None if there are no more items in the collection.
369 </pre>
370</div>
371
372</body></html>