Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / cloudiot_v1.projects.locations.registries.groups.html
blob: 146c0d82f4aa35e158371d85020e188f9495e7c0 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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
75<h1><a href="cloudiot_v1.html">Cloud IoT API</a> . <a href="cloudiot_v1.projects.html">projects</a> . <a href="cloudiot_v1.projects.locations.html">locations</a> . <a href="cloudiot_v1.projects.locations.registries.html">registries</a> . <a href="cloudiot_v1.projects.locations.registries.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudiot_v1.projects.locations.registries.groups.devices.html">devices()</a></code>
79</p>
80<p class="firstline">Returns the devices Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Gets the access control policy for a resource.</p>
85<p class="toc_element">
86 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
87<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
88<p class="toc_element">
89 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
94 <pre>Gets the access control policy for a resource.
95Returns an empty policy if the resource exists and does not have a policy
96set.
97
98Args:
99 resource: string, REQUIRED: The resource for which the policy is being requested.
100See the operation documentation for the appropriate value for this field. (required)
101 body: object, The request body.
102 The object takes the form of:
103
104{ # Request message for `GetIamPolicy` method.
105 }
106
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # Defines an Identity and Access Management (IAM) policy. It is used to
116 # specify access control policies for Cloud Platform resources.
117 #
118 #
119 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
120 # `members` to a `role`, where the members can be user accounts, Google groups,
121 # Google domains, and service accounts. A `role` is a named list of permissions
122 # defined by IAM.
123 #
124 # **JSON Example**
125 #
126 # {
127 # "bindings": [
128 # {
129 # "role": "roles/owner",
130 # "members": [
131 # "user:mike@example.com",
132 # "group:admins@example.com",
133 # "domain:google.com",
134 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
135 # ]
136 # },
137 # {
138 # "role": "roles/viewer",
139 # "members": ["user:sean@example.com"]
140 # }
141 # ]
142 # }
143 #
144 # **YAML Example**
145 #
146 # bindings:
147 # - members:
148 # - user:mike@example.com
149 # - group:admins@example.com
150 # - domain:google.com
151 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
152 # role: roles/owner
153 # - members:
154 # - user:sean@example.com
155 # role: roles/viewer
156 #
157 #
158 # For a description of IAM and its features, see the
159 # [IAM developer's guide](https://cloud.google.com/iam/docs).
160 "bindings": [ # Associates a list of `members` to a `role`.
161 # `bindings` with no members will result in an error.
162 { # Associates `members` with a `role`.
163 "role": "A String", # Role that is assigned to `members`.
164 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
165 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
166 # `members` can have the following values:
167 #
168 # * `allUsers`: A special identifier that represents anyone who is
169 # on the internet; with or without a Google account.
170 #
171 # * `allAuthenticatedUsers`: A special identifier that represents anyone
172 # who is authenticated with a Google account or a service account.
173 #
174 # * `user:{emailid}`: An email address that represents a specific Google
175 # account. For example, `alice@gmail.com` .
176 #
177 #
178 # * `serviceAccount:{emailid}`: An email address that represents a service
179 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
180 #
181 # * `group:{emailid}`: An email address that represents a Google group.
182 # For example, `admins@example.com`.
183 #
184 #
185 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
186 # users of that domain. For example, `google.com` or `example.com`.
187 #
188 "A String",
189 ],
190 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
191 # NOTE: An unsatisfied condition will not allow user access via current
192 # binding. Different bindings, including their conditions, are examined
193 # independently.
194 #
195 # title: "User account presence"
196 # description: "Determines whether the request has a user account"
197 # expression: "size(request.user) > 0"
198 "location": "A String", # An optional string indicating the location of the expression for error
199 # reporting, e.g. a file name and a position in the file.
200 "expression": "A String", # Textual representation of an expression in
201 # Common Expression Language syntax.
202 #
203 # The application context of the containing message determines which
204 # well-known feature set of CEL is supported.
205 "description": "A String", # An optional description of the expression. This is a longer text which
206 # describes the expression, e.g. when hovered over it in a UI.
207 "title": "A String", # An optional title for the expression, i.e. a short string describing
208 # its purpose. This can be used e.g. in UIs which allow to enter the
209 # expression.
210 },
211 },
212 ],
213 "version": 42, # Deprecated.
214 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
215 # prevent simultaneous updates of a policy from overwriting each other.
216 # It is strongly suggested that systems make use of the `etag` in the
217 # read-modify-write cycle to perform policy updates in order to avoid race
218 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
219 # systems are expected to put that etag in the request to `setIamPolicy` to
220 # ensure that their change will be applied to the same version of the policy.
221 #
222 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
223 # policy is overwritten blindly.
224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
229 <pre>Sets the access control policy on the specified resource. Replaces any
230existing policy.
231
232Args:
233 resource: string, REQUIRED: The resource for which the policy is being specified.
234See the operation documentation for the appropriate value for this field. (required)
235 body: object, The request body. (required)
236 The object takes the form of:
237
238{ # Request message for `SetIamPolicy` method.
239 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
240 # the policy is limited to a few 10s of KB. An empty policy is a
241 # valid policy but certain Cloud Platform services (such as Projects)
242 # might reject them.
243 # specify access control policies for Cloud Platform resources.
244 #
245 #
246 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
247 # `members` to a `role`, where the members can be user accounts, Google groups,
248 # Google domains, and service accounts. A `role` is a named list of permissions
249 # defined by IAM.
250 #
251 # **JSON Example**
252 #
253 # {
254 # "bindings": [
255 # {
256 # "role": "roles/owner",
257 # "members": [
258 # "user:mike@example.com",
259 # "group:admins@example.com",
260 # "domain:google.com",
261 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
262 # ]
263 # },
264 # {
265 # "role": "roles/viewer",
266 # "members": ["user:sean@example.com"]
267 # }
268 # ]
269 # }
270 #
271 # **YAML Example**
272 #
273 # bindings:
274 # - members:
275 # - user:mike@example.com
276 # - group:admins@example.com
277 # - domain:google.com
278 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
279 # role: roles/owner
280 # - members:
281 # - user:sean@example.com
282 # role: roles/viewer
283 #
284 #
285 # For a description of IAM and its features, see the
286 # [IAM developer's guide](https://cloud.google.com/iam/docs).
287 "bindings": [ # Associates a list of `members` to a `role`.
288 # `bindings` with no members will result in an error.
289 { # Associates `members` with a `role`.
290 "role": "A String", # Role that is assigned to `members`.
291 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
292 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
293 # `members` can have the following values:
294 #
295 # * `allUsers`: A special identifier that represents anyone who is
296 # on the internet; with or without a Google account.
297 #
298 # * `allAuthenticatedUsers`: A special identifier that represents anyone
299 # who is authenticated with a Google account or a service account.
300 #
301 # * `user:{emailid}`: An email address that represents a specific Google
302 # account. For example, `alice@gmail.com` .
303 #
304 #
305 # * `serviceAccount:{emailid}`: An email address that represents a service
306 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
307 #
308 # * `group:{emailid}`: An email address that represents a Google group.
309 # For example, `admins@example.com`.
310 #
311 #
312 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
313 # users of that domain. For example, `google.com` or `example.com`.
314 #
315 "A String",
316 ],
317 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
318 # NOTE: An unsatisfied condition will not allow user access via current
319 # binding. Different bindings, including their conditions, are examined
320 # independently.
321 #
322 # title: "User account presence"
323 # description: "Determines whether the request has a user account"
324 # expression: "size(request.user) > 0"
325 "location": "A String", # An optional string indicating the location of the expression for error
326 # reporting, e.g. a file name and a position in the file.
327 "expression": "A String", # Textual representation of an expression in
328 # Common Expression Language syntax.
329 #
330 # The application context of the containing message determines which
331 # well-known feature set of CEL is supported.
332 "description": "A String", # An optional description of the expression. This is a longer text which
333 # describes the expression, e.g. when hovered over it in a UI.
334 "title": "A String", # An optional title for the expression, i.e. a short string describing
335 # its purpose. This can be used e.g. in UIs which allow to enter the
336 # expression.
337 },
338 },
339 ],
340 "version": 42, # Deprecated.
341 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
342 # prevent simultaneous updates of a policy from overwriting each other.
343 # It is strongly suggested that systems make use of the `etag` in the
344 # read-modify-write cycle to perform policy updates in order to avoid race
345 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
346 # systems are expected to put that etag in the request to `setIamPolicy` to
347 # ensure that their change will be applied to the same version of the policy.
348 #
349 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
350 # policy is overwritten blindly.
351 },
352 }
353
354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
358
359Returns:
360 An object of the form:
361
362 { # Defines an Identity and Access Management (IAM) policy. It is used to
363 # specify access control policies for Cloud Platform resources.
364 #
365 #
366 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
367 # `members` to a `role`, where the members can be user accounts, Google groups,
368 # Google domains, and service accounts. A `role` is a named list of permissions
369 # defined by IAM.
370 #
371 # **JSON Example**
372 #
373 # {
374 # "bindings": [
375 # {
376 # "role": "roles/owner",
377 # "members": [
378 # "user:mike@example.com",
379 # "group:admins@example.com",
380 # "domain:google.com",
381 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
382 # ]
383 # },
384 # {
385 # "role": "roles/viewer",
386 # "members": ["user:sean@example.com"]
387 # }
388 # ]
389 # }
390 #
391 # **YAML Example**
392 #
393 # bindings:
394 # - members:
395 # - user:mike@example.com
396 # - group:admins@example.com
397 # - domain:google.com
398 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
399 # role: roles/owner
400 # - members:
401 # - user:sean@example.com
402 # role: roles/viewer
403 #
404 #
405 # For a description of IAM and its features, see the
406 # [IAM developer's guide](https://cloud.google.com/iam/docs).
407 "bindings": [ # Associates a list of `members` to a `role`.
408 # `bindings` with no members will result in an error.
409 { # Associates `members` with a `role`.
410 "role": "A String", # Role that is assigned to `members`.
411 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
412 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
413 # `members` can have the following values:
414 #
415 # * `allUsers`: A special identifier that represents anyone who is
416 # on the internet; with or without a Google account.
417 #
418 # * `allAuthenticatedUsers`: A special identifier that represents anyone
419 # who is authenticated with a Google account or a service account.
420 #
421 # * `user:{emailid}`: An email address that represents a specific Google
422 # account. For example, `alice@gmail.com` .
423 #
424 #
425 # * `serviceAccount:{emailid}`: An email address that represents a service
426 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
427 #
428 # * `group:{emailid}`: An email address that represents a Google group.
429 # For example, `admins@example.com`.
430 #
431 #
432 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
433 # users of that domain. For example, `google.com` or `example.com`.
434 #
435 "A String",
436 ],
437 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
438 # NOTE: An unsatisfied condition will not allow user access via current
439 # binding. Different bindings, including their conditions, are examined
440 # independently.
441 #
442 # title: "User account presence"
443 # description: "Determines whether the request has a user account"
444 # expression: "size(request.user) > 0"
445 "location": "A String", # An optional string indicating the location of the expression for error
446 # reporting, e.g. a file name and a position in the file.
447 "expression": "A String", # Textual representation of an expression in
448 # Common Expression Language syntax.
449 #
450 # The application context of the containing message determines which
451 # well-known feature set of CEL is supported.
452 "description": "A String", # An optional description of the expression. This is a longer text which
453 # describes the expression, e.g. when hovered over it in a UI.
454 "title": "A String", # An optional title for the expression, i.e. a short string describing
455 # its purpose. This can be used e.g. in UIs which allow to enter the
456 # expression.
457 },
458 },
459 ],
460 "version": 42, # Deprecated.
461 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
462 # prevent simultaneous updates of a policy from overwriting each other.
463 # It is strongly suggested that systems make use of the `etag` in the
464 # read-modify-write cycle to perform policy updates in order to avoid race
465 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
466 # systems are expected to put that etag in the request to `setIamPolicy` to
467 # ensure that their change will be applied to the same version of the policy.
468 #
469 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
470 # policy is overwritten blindly.
471 }</pre>
472</div>
473
474<div class="method">
475 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
476 <pre>Returns permissions that a caller has on the specified resource.
477If the resource does not exist, this will return an empty set of
478permissions, not a NOT_FOUND error.
479
480Args:
481 resource: string, REQUIRED: The resource for which the policy detail is being requested.
482See the operation documentation for the appropriate value for this field. (required)
483 body: object, The request body. (required)
484 The object takes the form of:
485
486{ # Request message for `TestIamPermissions` method.
487 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
488 # wildcards (such as '*' or 'storage.*') are not allowed. For more
489 # information see
490 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
491 "A String",
492 ],
493 }
494
495 x__xgafv: string, V1 error format.
496 Allowed values
497 1 - v1 error format
498 2 - v2 error format
499
500Returns:
501 An object of the form:
502
503 { # Response message for `TestIamPermissions` method.
504 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
505 # allowed.
506 "A String",
507 ],
508 }</pre>
509</div>
510
511</body></html>