Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudresourcemanager_v1.liens.html
blob: 6aec197ba775aed61d598c8264c9cb2288fca417 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission requires permission `resourcemanager.projects.get` or `resourcemanager.projects.updateLiens`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]90 <code><a href="#list">list(pageToken=None, parent=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <pre>Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]104
105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]107 The object takes the form of:
108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109{ # A Lien represents an encumbrance on the actions that can be performed on a resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]110 &quot;reason&quot;: &quot;A String&quot;, # Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: &#x27;Holds production API key&#x27;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]111 &quot;parent&quot;: &quot;A String&quot;, # A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]112 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of this Lien.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]113 &quot;name&quot;: &quot;A String&quot;, # A system-generated unique identifier for this Lien. Example: `liens/1234abcd`
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]114 &quot;origin&quot;: &quot;A String&quot;, # A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: &#x27;compute.googleapis.com&#x27;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]115 &quot;restrictions&quot;: [ # The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: [&#x27;resourcemanager.projects.delete&#x27;]
116 &quot;A String&quot;,
117 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118}
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]119
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 { # A Lien represents an encumbrance on the actions that can be performed on a resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]129 &quot;reason&quot;: &quot;A String&quot;, # Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: &#x27;Holds production API key&#x27;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;parent&quot;: &quot;A String&quot;, # A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]131 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of this Lien.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]132 &quot;name&quot;: &quot;A String&quot;, # A system-generated unique identifier for this Lien. Example: `liens/1234abcd`
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 &quot;origin&quot;: &quot;A String&quot;, # A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: &#x27;compute.googleapis.com&#x27;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]134 &quot;restrictions&quot;: [ # The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: [&#x27;resourcemanager.projects.delete&#x27;]
135 &quot;A String&quot;,
136 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]137 }</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138</div>
139
140<div class="method">
141 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 <pre>Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143
144Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 name: string, Required. The name/identifier of the Lien to delete. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 <pre>Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission requires permission `resourcemanager.projects.get` or `resourcemanager.projects.updateLiens`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161
162Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 name: string, Required. The name/identifier of the Lien. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 { # A Lien represents an encumbrance on the actions that can be performed on a resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;reason&quot;: &quot;A String&quot;, # Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: &#x27;Holds production API key&#x27;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]174 &quot;parent&quot;: &quot;A String&quot;, # A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]175 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of this Lien.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]176 &quot;name&quot;: &quot;A String&quot;, # A system-generated unique identifier for this Lien. Example: `liens/1234abcd`
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]177 &quot;origin&quot;: &quot;A String&quot;, # A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: &#x27;compute.googleapis.com&#x27;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]178 &quot;restrictions&quot;: [ # The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: [&#x27;resourcemanager.projects.delete&#x27;]
179 &quot;A String&quot;,
180 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]181 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182</div>
183
184<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]185 <code class="details" id="list">list(pageToken=None, parent=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]186 <pre>List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187
188Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]189 pageToken: string, The `next_page_token` value returned from a previous List request, if any.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]190 parent: string, Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]191 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]192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]196
197Returns:
198 An object of the form:
199
200 { # The response message for Liens.ListLiens.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;liens&quot;: [ # A list of Liens.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 { # A Lien represents an encumbrance on the actions that can be performed on a resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]203 &quot;reason&quot;: &quot;A String&quot;, # Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: &#x27;Holds production API key&#x27;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]204 &quot;parent&quot;: &quot;A String&quot;, # A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]205 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of this Lien.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]206 &quot;name&quot;: &quot;A String&quot;, # A system-generated unique identifier for this Lien. Example: `liens/1234abcd`
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]207 &quot;origin&quot;: &quot;A String&quot;, # A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: &#x27;compute.googleapis.com&#x27;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]208 &quot;restrictions&quot;: [ # The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: [&#x27;resourcemanager.projects.delete&#x27;]
209 &quot;A String&quot;,
210 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]211 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]212 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]213 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
219 <pre>Retrieves the next page of results.
220
221Args:
222 previous_request: The request for the previous page. (required)
223 previous_response: The response from the request for the previous page. (required)
224
225Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]227 page. Returns None if there are no more items in the collection.
228 </pre>
229</div>
230
231</body></html>