| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | 715bd7f | 2019-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 Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 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 Kim | 715bd7f | 2019-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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(pageSize=None, parent=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 94 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 95 | <pre>Create a Lien which applies to the resource denoted by the `parent` field. |
| 96 | |
| 97 | Callers of this method will require permission on the `parent` resource. |
| 98 | For example, applying to `projects/1234` requires permission |
| 99 | `resourcemanager.projects.updateLiens`. |
| 100 | |
| 101 | NOTE: Some resources may limit the number of Liens which may be applied. |
| 102 | |
| 103 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | body: object, The request body. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 105 | The object takes the form of: |
| 106 | |
| 107 | { # A Lien represents an encumbrance on the actions that can be performed on a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | # resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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' |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 114 | "createTime": "A String", # The creation time of this Lien. |
| 115 | "name": "A String", # A system-generated unique identifier for this Lien. |
| 116 | # |
| 117 | # Example: `liens/1234abcd` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | "restrictions": [ # The types of operations which should be blocked as a result of this Lien. |
| 119 | # Each value should correspond to an IAM permission. The server will |
| 120 | # validate the permissions against those for which Liens are supported. |
| 121 | # |
| 122 | # An empty list is meaningless and will be rejected. |
| 123 | # |
| 124 | # Example: ['resourcemanager.projects.delete'] |
| 125 | "A String", |
| 126 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 127 | "parent": "A String", # A reference to the resource this Lien is attached to. The server will |
| 128 | # validate the parent against those for which Liens are supported. |
| 129 | # |
| 130 | # Example: `projects/1234` |
| 131 | "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed |
| 132 | # on a resource. Maximum length of 200 characters. |
| 133 | # |
| 134 | # Example: 'Holds production API key' |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | } |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 136 | |
| 137 | x__xgafv: string, V1 error format. |
| 138 | Allowed values |
| 139 | 1 - v1 error format |
| 140 | 2 - v2 error format |
| 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| 145 | { # A Lien represents an encumbrance on the actions that can be performed on a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | # resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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' |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | "createTime": "A String", # The creation time of this Lien. |
| 153 | "name": "A String", # A system-generated unique identifier for this Lien. |
| 154 | # |
| 155 | # Example: `liens/1234abcd` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "restrictions": [ # The types of operations which should be blocked as a result of this Lien. |
| 157 | # Each value should correspond to an IAM permission. The server will |
| 158 | # validate the permissions against those for which Liens are supported. |
| 159 | # |
| 160 | # An empty list is meaningless and will be rejected. |
| 161 | # |
| 162 | # Example: ['resourcemanager.projects.delete'] |
| 163 | "A String", |
| 164 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 165 | "parent": "A String", # A reference to the resource this Lien is attached to. The server will |
| 166 | # validate the parent against those for which Liens are supported. |
| 167 | # |
| 168 | # Example: `projects/1234` |
| 169 | "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed |
| 170 | # on a resource. Maximum length of 200 characters. |
| 171 | # |
| 172 | # Example: 'Holds production API key' |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 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 | |
| 180 | Callers of this method will require permission on the `parent` resource. |
| 181 | For example, a Lien with a `parent` of `projects/1234` requires permission |
| 182 | `resourcemanager.projects.updateLiens`. |
| 183 | |
| 184 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 185 | name: string, Required. The name/identifier of the Lien to delete. (required) |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 186 | x__xgafv: string, V1 error format. |
| 187 | Allowed values |
| 188 | 1 - v1 error format |
| 189 | 2 - v2 error format |
| 190 | |
| 191 | Returns: |
| 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 Kim | 715bd7f | 2019-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 | |
| 210 | Callers of this method will require permission on the `parent` resource. |
| 211 | For example, a Lien with a `parent` of `projects/1234` requires permission |
| 212 | requires permission `resourcemanager.projects.get` or |
| 213 | `resourcemanager.projects.updateLiens`. |
| 214 | |
| 215 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 216 | name: string, Required. The name/identifier of the Lien. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 217 | x__xgafv: string, V1 error format. |
| 218 | Allowed values |
| 219 | 1 - v1 error format |
| 220 | 2 - v2 error format |
| 221 | |
| 222 | Returns: |
| 223 | An object of the form: |
| 224 | |
| 225 | { # A Lien represents an encumbrance on the actions that can be performed on a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | # resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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' |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 232 | "createTime": "A String", # The creation time of this Lien. |
| 233 | "name": "A String", # A system-generated unique identifier for this Lien. |
| 234 | # |
| 235 | # Example: `liens/1234abcd` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | "restrictions": [ # The types of operations which should be blocked as a result of this Lien. |
| 237 | # Each value should correspond to an IAM permission. The server will |
| 238 | # validate the permissions against those for which Liens are supported. |
| 239 | # |
| 240 | # An empty list is meaningless and will be rejected. |
| 241 | # |
| 242 | # Example: ['resourcemanager.projects.delete'] |
| 243 | "A String", |
| 244 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 245 | "parent": "A String", # A reference to the resource this Lien is attached to. The server will |
| 246 | # validate the parent against those for which Liens are supported. |
| 247 | # |
| 248 | # Example: `projects/1234` |
| 249 | "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed |
| 250 | # on a resource. Maximum length of 200 characters. |
| 251 | # |
| 252 | # Example: 'Holds production API key' |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 254 | </div> |
| 255 | |
| 256 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 257 | <code class="details" id="list">list(pageSize=None, parent=None, pageToken=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 258 | <pre>List all Liens applied to the `parent` resource. |
| 259 | |
| 260 | Callers of this method will require permission on the `parent` resource. |
| 261 | For example, a Lien with a `parent` of `projects/1234` requires permission |
| 262 | `resourcemanager.projects.get`. |
| 263 | |
| 264 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 265 | pageSize: integer, The maximum number of items to return. This is a suggestion for the server. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 266 | parent: string, Required. The name of the resource to list all attached Liens. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 267 | For example, `projects/1234`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 268 | |
| 269 | (google.api.field_policy).resource_type annotation is not set since the |
| 270 | parent depends on the meta api implementation. This field could be a |
| 271 | project or other sub project resources. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 272 | pageToken: string, The `next_page_token` value returned from a previous List request, if any. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 273 | x__xgafv: string, V1 error format. |
| 274 | Allowed values |
| 275 | 1 - v1 error format |
| 276 | 2 - v2 error format |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 277 | |
| 278 | Returns: |
| 279 | An object of the form: |
| 280 | |
| 281 | { # The response message for Liens.ListLiens. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 282 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more |
| 283 | # results in the list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | "liens": [ # A list of Liens. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 285 | { # A Lien represents an encumbrance on the actions that can be performed on a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | # resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 287 | "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the |
| 288 | # Lien, intended to be inspected programmatically. Maximum length of 200 |
| 289 | # characters. |
| 290 | # |
| 291 | # Example: 'compute.googleapis.com' |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 292 | "createTime": "A String", # The creation time of this Lien. |
| 293 | "name": "A String", # A system-generated unique identifier for this Lien. |
| 294 | # |
| 295 | # Example: `liens/1234abcd` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 296 | "restrictions": [ # The types of operations which should be blocked as a result of this Lien. |
| 297 | # Each value should correspond to an IAM permission. The server will |
| 298 | # validate the permissions against those for which Liens are supported. |
| 299 | # |
| 300 | # An empty list is meaningless and will be rejected. |
| 301 | # |
| 302 | # Example: ['resourcemanager.projects.delete'] |
| 303 | "A String", |
| 304 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 305 | "parent": "A String", # A reference to the resource this Lien is attached to. The server will |
| 306 | # validate the parent against those for which Liens are supported. |
| 307 | # |
| 308 | # Example: `projects/1234` |
| 309 | "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed |
| 310 | # on a resource. Maximum length of 200 characters. |
| 311 | # |
| 312 | # Example: 'Holds production API key' |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 314 | ], |
| 315 | }</pre> |
| 316 | </div> |
| 317 | |
| 318 | <div class="method"> |
| 319 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 320 | <pre>Retrieves the next page of results. |
| 321 | |
| 322 | Args: |
| 323 | previous_request: The request for the previous page. (required) |
| 324 | previous_response: The response from the request for the previous page. (required) |
| 325 | |
| 326 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 327 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 328 | page. Returns None if there are no more items in the collection. |
| 329 | </pre> |
| 330 | </div> |
| 331 | |
| 332 | </body></html> |