Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / secretmanager_v1beta1.projects.secrets.versions.html
blob: ca707c7025ffb61ab6e9aa5076fb9a3568178a63 [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_v1beta1.html">Secret Manager API</a> . <a href="secretmanager_v1beta1.projects.html">projects</a> . <a href="secretmanager_v1beta1.projects.secrets.html">secrets</a> . <a href="secretmanager_v1beta1.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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -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 `latest` SecretVersion.</p>
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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]96 <code><a href="#list">list(parent, pageToken=None, pageSize=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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104 <pre>Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105
106Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107 name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. (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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]117 &quot;name&quot;: &quot;A String&quot;, # The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 &quot;payload&quot;: { # A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. # Secret payload
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;data&quot;: &quot;A String&quot;, # The secret data. Must be no larger than 64KiB.
120 },
121 }</pre>
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.
139 }
140
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # A secret version resource in the Secret Manager API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]151 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]152 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]153 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 <pre>Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160
161Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 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]163 body: object, The request body.
164 The object takes the form of:
165
166{ # Request message for SecretManagerService.DisableSecretVersion.
167 }
168
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
177 { # A secret version resource in the Secret Manager API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]179 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]180 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]181 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]187 <pre>Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188
189Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]190 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]191 body: object, The request body.
192 The object takes the form of:
193
194{ # Request message for SecretManagerService.EnableSecretVersion.
195 }
196
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202Returns:
203 An object of the form:
204
205 { # A secret version resource in the Secret Manager API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]206 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]207 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]208 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]209 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]215 <pre>Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216
217Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]218 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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224Returns:
225 An object of the form:
226
227 { # A secret version resource in the Secret Manager API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]228 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]229 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]230 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]231 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]236 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]237 <pre>Lists SecretVersions. This call does not return secret data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238
239Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]240 parent: string, Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*`. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]241 pageToken: string, Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]242 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
251 { # Response message for SecretManagerService.ListSecretVersions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]252 &quot;totalSize&quot;: 42, # The total number of SecretVersions.
253 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]254 &quot;versions&quot;: [ # The list of SecretVersions sorted in reverse by create_time (newest first).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 { # A secret version resource in the Secret Manager API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]256 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]257 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]258 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]259 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 },
261 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
267 <pre>Retrieves the next page of results.
268
269Args:
270 previous_request: The request for the previous page. (required)
271 previous_response: The response from the request for the previous page. (required)
272
273Returns:
274 A request object that you can call &#x27;execute()&#x27; on to request the next
275 page. Returns None if there are no more items in the collection.
276 </pre>
277</div>
278
279</body></html>