1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<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. `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. 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. 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. 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. `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 data.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</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.
Args:
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
2 - v2 error format
Returns:
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 sensitive secret data 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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<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)
body: object, The request body.
The object takes the form of:
{ # Request message for SecretManagerService.DestroySecretVersion.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A secret version resource in the Secret Manager API.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"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.
"state": "A String", # Output only. The current state of the SecretVersion.
}</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.
Args:
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:
{ # Request message for SecretManagerService.DisableSecretVersion.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A secret version resource in the Secret Manager API.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"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.
"state": "A String", # Output only. The current state of the SecretVersion.
}</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.
Args:
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:
{ # Request message for SecretManagerService.EnableSecretVersion.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A secret version resource in the Secret Manager API.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"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.
"state": "A String", # Output only. The current state of the SecretVersion.
}</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.
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A secret version resource in the Secret Manager API.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"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.
"state": "A String", # Output only. The current state of the SecretVersion.
}</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.
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][].
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
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).
{ # A secret version resource in the Secret Manager API.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
"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.
"state": "A String", # Output only. The current state of the SecretVersion.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
