File: cloudresourcemanager_v1.liens.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (328 lines) | stat: -rw-r--r-- 11,663 bytes parent folder | download | duplicates (2)
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<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="cloudresourcemanager_v1.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.liens.html">liens</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
<p class="firstline">Create a Lien which applies to the resource denoted by the `parent` field.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a Lien by `name`.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve a Lien by `name`.</p>
<p class="toc_element">
  <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">List all Liens applied to the `parent` resource.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(body, x__xgafv=None)</code>
  <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.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A Lien represents an encumbrance on the actions that can be performed on a
      # resource.
    "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
        # Lien, intended to be inspected programmatically. Maximum length of 200
        # characters.
        # 
        # Example: 'compute.googleapis.com'
    "restrictions": [ # 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: ['resourcemanager.projects.delete']
      "A String",
    ],
    "name": "A String", # A system-generated unique identifier for this Lien.
        # 
        # Example: `liens/1234abcd`
    "parent": "A String", # 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`
    "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
        # on a resource. Maximum length of 200 characters.
        # 
        # Example: 'Holds production API key'
    "createTime": "A String", # The creation time of this Lien.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Lien represents an encumbrance on the actions that can be performed on a
        # resource.
      "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
          # Lien, intended to be inspected programmatically. Maximum length of 200
          # characters.
          #
          # Example: 'compute.googleapis.com'
      "restrictions": [ # 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: ['resourcemanager.projects.delete']
        "A String",
      ],
      "name": "A String", # A system-generated unique identifier for this Lien.
          #
          # Example: `liens/1234abcd`
      "parent": "A String", # 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`
      "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
          # on a resource. Maximum length of 200 characters.
          #
          # Example: 'Holds production API key'
      "createTime": "A String", # The creation time of this Lien.
    }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <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`.

Args:
  name: string, The name/identifier of the Lien to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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 `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <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`.

Args:
  name: string, The name/identifier of the Lien. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Lien represents an encumbrance on the actions that can be performed on a
        # resource.
      "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
          # Lien, intended to be inspected programmatically. Maximum length of 200
          # characters.
          #
          # Example: 'compute.googleapis.com'
      "restrictions": [ # 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: ['resourcemanager.projects.delete']
        "A String",
      ],
      "name": "A String", # A system-generated unique identifier for this Lien.
          #
          # Example: `liens/1234abcd`
      "parent": "A String", # 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`
      "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
          # on a resource. Maximum length of 200 characters.
          #
          # Example: 'Holds production API key'
      "createTime": "A String", # The creation time of this Lien.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
  <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`.

Args:
  parent: string, The name of the resource to list all attached Liens.
For example, `projects/1234`.
  pageToken: string, The `next_page_token` value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, The maximum number of items to return. This is a suggestion for the server.

Returns:
  An object of the form:

    { # The response message for Liens.ListLiens.
    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
        # results in the list.
    "liens": [ # A list of Liens.
      { # A Lien represents an encumbrance on the actions that can be performed on a
            # resource.
          "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
              # Lien, intended to be inspected programmatically. Maximum length of 200
              # characters.
              #
              # Example: 'compute.googleapis.com'
          "restrictions": [ # 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: ['resourcemanager.projects.delete']
            "A String",
          ],
          "name": "A String", # A system-generated unique identifier for this Lien.
              #
              # Example: `liens/1234abcd`
          "parent": "A String", # 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`
          "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
              # on a resource. Maximum length of 200 characters.
              #
              # Example: 'Holds production API key'
          "createTime": "A String", # The creation time of this Lien.
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</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>