Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / cloudresourcemanager_v1.liens.html
blob: cbfbd51348df6c5e6b001e6b9ca1337faec2b670 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudresourcemanager_v1.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.liens.html">liens</a></h1>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Create a Lien which applies to the resource denoted by the `parent` field.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Delete a Lien by `name`.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieve a Lien by `name`.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">List all Liens applied to the `parent` resource.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(body, x__xgafv=None)</code>
95 <pre>Create a Lien which applies to the resource denoted by the `parent` field.
96
97Callers of this method will require permission on the `parent` resource.
98For example, applying to `projects/1234` requires permission
99`resourcemanager.projects.updateLiens`.
100
101NOTE: Some resources may limit the number of Liens which may be applied.
102
103Args:
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{ # A Lien represents an encumbrance on the actions that can be performed on a
108 # resource.
109 "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
110 # Lien, intended to be inspected programmatically. Maximum length of 200
111 # characters.
112 #
113 # Example: 'compute.googleapis.com'
114 "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
115 # Each value should correspond to an IAM permission. The server will
116 # validate the permissions against those for which Liens are supported.
117 #
118 # An empty list is meaningless and will be rejected.
119 #
120 # Example: ['resourcemanager.projects.delete']
121 "A String",
122 ],
123 "name": "A String", # A system-generated unique identifier for this Lien.
124 #
125 # Example: `liens/1234abcd`
126 "parent": "A String", # A reference to the resource this Lien is attached to. The server will
127 # validate the parent against those for which Liens are supported.
128 #
129 # Example: `projects/1234`
130 "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 # on a resource. Maximum length of 200 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]132 #
133 # Example: 'Holds production API key'
134 "createTime": "A String", # The creation time of this Lien.
135 }
136
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142Returns:
143 An object of the form:
144
145 { # A Lien represents an encumbrance on the actions that can be performed on a
146 # resource.
147 "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
148 # Lien, intended to be inspected programmatically. Maximum length of 200
149 # characters.
150 #
151 # Example: 'compute.googleapis.com'
152 "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
153 # Each value should correspond to an IAM permission. The server will
154 # validate the permissions against those for which Liens are supported.
155 #
156 # An empty list is meaningless and will be rejected.
157 #
158 # Example: ['resourcemanager.projects.delete']
159 "A String",
160 ],
161 "name": "A String", # A system-generated unique identifier for this Lien.
162 #
163 # Example: `liens/1234abcd`
164 "parent": "A String", # A reference to the resource this Lien is attached to. The server will
165 # validate the parent against those for which Liens are supported.
166 #
167 # Example: `projects/1234`
168 "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 # on a resource. Maximum length of 200 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]170 #
171 # Example: 'Holds production API key'
172 "createTime": "A String", # The creation time of this Lien.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
178 <pre>Delete a Lien by `name`.
179
180Callers of this method will require permission on the `parent` resource.
181For example, a Lien with a `parent` of `projects/1234` requires permission
182`resourcemanager.projects.updateLiens`.
183
184Args:
185 name: string, The name/identifier of the Lien to delete. (required)
186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
194 { # A generic empty message that you can re-use to avoid defining duplicated
195 # empty messages in your APIs. A typical example is to use it as the request
196 # or the response type of an API method. For instance:
197 #
198 # service Foo {
199 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
200 # }
201 #
202 # The JSON representation for `Empty` is empty JSON object `{}`.
203 }</pre>
204</div>
205
206<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 <code class="details" id="get">get(name, x__xgafv=None)</code>
208 <pre>Retrieve a Lien by `name`.
209
210Callers of this method will require permission on the `parent` resource.
211For example, a Lien with a `parent` of `projects/1234` requires permission
212requires permission `resourcemanager.projects.get` or
213`resourcemanager.projects.updateLiens`.
214
215Args:
216 name: string, The name/identifier of the Lien. (required)
217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
221
222Returns:
223 An object of the form:
224
225 { # A Lien represents an encumbrance on the actions that can be performed on a
226 # resource.
227 "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
228 # Lien, intended to be inspected programmatically. Maximum length of 200
229 # characters.
230 #
231 # Example: 'compute.googleapis.com'
232 "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
233 # Each value should correspond to an IAM permission. The server will
234 # validate the permissions against those for which Liens are supported.
235 #
236 # An empty list is meaningless and will be rejected.
237 #
238 # Example: ['resourcemanager.projects.delete']
239 "A String",
240 ],
241 "name": "A String", # A system-generated unique identifier for this Lien.
242 #
243 # Example: `liens/1234abcd`
244 "parent": "A String", # A reference to the resource this Lien is attached to. The server will
245 # validate the parent against those for which Liens are supported.
246 #
247 # Example: `projects/1234`
248 "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
249 # on a resource. Maximum length of 200 characters.
250 #
251 # Example: 'Holds production API key'
252 "createTime": "A String", # The creation time of this Lien.
253 }</pre>
254</div>
255
256<div class="method">
257 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]258 <pre>List all Liens applied to the `parent` resource.
259
260Callers of this method will require permission on the `parent` resource.
261For example, a Lien with a `parent` of `projects/1234` requires permission
262`resourcemanager.projects.get`.
263
264Args:
265 parent: string, The name of the resource to list all attached Liens.
266For example, `projects/1234`.
267 pageToken: string, The `next_page_token` value returned from a previous List request, if any.
268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 pageSize: integer, The maximum number of items to return. This is a suggestion for the server.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]273
274Returns:
275 An object of the form:
276
277 { # The response message for Liens.ListLiens.
278 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
279 # results in the list.
280 "liens": [ # A list of Liens.
281 { # A Lien represents an encumbrance on the actions that can be performed on a
282 # resource.
283 "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
284 # Lien, intended to be inspected programmatically. Maximum length of 200
285 # characters.
286 #
287 # Example: 'compute.googleapis.com'
288 "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
289 # Each value should correspond to an IAM permission. The server will
290 # validate the permissions against those for which Liens are supported.
291 #
292 # An empty list is meaningless and will be rejected.
293 #
294 # Example: ['resourcemanager.projects.delete']
295 "A String",
296 ],
297 "name": "A String", # A system-generated unique identifier for this Lien.
298 #
299 # Example: `liens/1234abcd`
300 "parent": "A String", # A reference to the resource this Lien is attached to. The server will
301 # validate the parent against those for which Liens are supported.
302 #
303 # Example: `projects/1234`
304 "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 # on a resource. Maximum length of 200 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]306 #
307 # Example: 'Holds production API key'
308 "createTime": "A String", # The creation time of this Lien.
309 },
310 ],
311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
316 <pre>Retrieves the next page of results.
317
318Args:
319 previous_request: The request for the previous page. (required)
320 previous_response: The response from the request for the previous page. (required)
321
322Returns:
323 A request object that you can call 'execute()' on to request the next
324 page. Returns None if there are no more items in the collection.
325 </pre>
326</div>
327
328</body></html>