Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudresourcemanager_v2.folders.html
blob: 9618c2ea5d434559943b13d3940c3256cba1f4ff [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="cloudresourcemanager_v2.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v2.folders.html">folders</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(body=None, parent=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a Folder in the resource hierarchy.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Requests deletion of a Folder. The Folder is moved into the</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a Folder identified by the supplied resource name.</p>
86<p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the access control policy for a Folder. The returned policy may be</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent=None, showDeleted=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
91<p class="firstline">Lists the Folders that are direct descendants of supplied parent resource.</p>
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<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Moves a Folder under a new resource parent.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Updates a Folder, changing its display_name.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Search for folders that match specific filter criteria.</p>
104<p class="toc_element">
105 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Sets the access control policy on a Folder, replacing any existing policy.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112<p class="firstline">Returns permissions that a caller has on the specified Folder.</p>
113<p class="toc_element">
114 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Cancels the deletion request for a Folder. This method may only be</p>
116<h3>Method Details</h3>
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code class="details" id="create">create(body=None, parent=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 <pre>Creates a Folder in the resource hierarchy.
120Returns an Operation which can be used to track the progress of the
121folder creation workflow.
122Upon success the Operation.response field will be populated with the
123created Folder.
124
125In order to succeed, the addition of this new Folder must not violate
126the Folder naming, height or fanout constraints.
127
128+ The Folder's display_name must be distinct from all other Folder's that
129share its parent.
130+ The addition of the Folder must not cause the active Folder hierarchy
131to exceed a height of 4. Note, the full active + deleted Folder hierarchy
132is allowed to reach a height of 8; this provides additional headroom when
133moving folders that contain deleted folders.
134+ The addition of the Folder must not cause the total number of Folders
135under its parent to exceed 100.
136
137If the operation fails due to a folder constraint violation, some errors
138may be returned by the CreateFolder request, with status code
139FAILED_PRECONDITION and an error description. Other folder constraint
140violations will be communicated in the Operation, with the specific
141PreconditionFailure returned via the details list in the Operation.error
142field.
143
144The caller must have `resourcemanager.folders.create` permission on the
145identified parent.
146
147Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 The object takes the form of:
150
151{ # A Folder in an Organization's resource hierarchy, used to
152 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]153 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
154 # Updates to the lifecycle_state must be performed via
155 # DeleteFolder and
156 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "displayName": "A String", # The folder’s display name.
158 # A folder’s display name must be unique amongst its siblings, e.g.
159 # no two folders with the same parent can share the same display name.
160 # The display name must start and end with a letter or digit, may contain
161 # letters, digits, spaces, hyphens and underscores and can be no longer
162 # than 30 characters. This is captured by the regular expression:
163 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "name": "A String", # Output only. The resource name of the Folder.
165 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]166 "parent": "A String", # Required. The Folder’s parent's resource name.
167 # Updates to the folder's parent must be performed via
168 # MoveFolder.
169 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170}
171
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]172 parent: string, Required. The resource name of the new Folder's parent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179Returns:
180 An object of the form:
181
182 { # This resource represents a long-running operation that is the result of a
183 # network API call.
184 "response": { # The normal response of the operation in case of success. If the original
185 # method returns no data on success, such as `Delete`, the response is
186 # `google.protobuf.Empty`. If the original method is standard
187 # `Get`/`Create`/`Update`, the response should be the resource. For other
188 # methods, the response should have the type `XxxResponse`, where `Xxx`
189 # is the original method name. For example, if the original method name
190 # is `TakeSnapshot()`, the inferred response type is
191 # `TakeSnapshotResponse`.
192 "a_key": "", # Properties of the object. Contains field @type with type URL.
193 },
194 "metadata": { # Service-specific metadata associated with the operation. It typically
195 # contains progress information and common metadata such as create time.
196 # Some services might not provide such metadata. Any method that returns a
197 # long-running operation should document the metadata type, if any.
198 "a_key": "", # Properties of the object. Contains field @type with type URL.
199 },
200 "done": True or False, # If the value is `false`, it means the operation is still in progress.
201 # If `true`, the operation is completed, and either `error` or `response` is
202 # available.
203 "name": "A String", # The server-assigned name, which is only unique within the same service that
204 # originally returns it. If you use the default HTTP mapping, the
205 # `name` should be a resource name ending with `operations/{unique_id}`.
206 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
207 # different programming environments, including REST APIs and RPC APIs. It is
208 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
209 # three pieces of data: error code, error message, and error details.
210 #
211 # You can find out more about this error model and how to work with it in the
212 # [API Design Guide](https://cloud.google.com/apis/design/errors).
213 "message": "A String", # A developer-facing error message, which should be in English. Any
214 # user-facing error message should be localized and sent in the
215 # google.rpc.Status.details field, or localized by the client.
216 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
217 "details": [ # A list of messages that carry the error details. There is a common set of
218 # message types for APIs to use.
219 {
220 "a_key": "", # Properties of the object. Contains field @type with type URL.
221 },
222 ],
223 },
224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
229 <pre>Requests deletion of a Folder. The Folder is moved into the
230DELETE_REQUESTED state
231immediately, and is deleted approximately 30 days later. This method may
232only be called on an empty Folder in the
233ACTIVE state, where a Folder is empty if
234it doesn't contain any Folders or Projects in the
235ACTIVE state.
236The caller must have `resourcemanager.folders.delete` permission on the
237identified folder.
238
239Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240 name: string, Required. the resource name of the Folder to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241Must be of the form `folders/{folder_id}`. (required)
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # A Folder in an Organization's resource hierarchy, used to
251 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
253 # Updates to the lifecycle_state must be performed via
254 # DeleteFolder and
255 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "displayName": "A String", # The folder’s display name.
257 # A folder’s display name must be unique amongst its siblings, e.g.
258 # no two folders with the same parent can share the same display name.
259 # The display name must start and end with a letter or digit, may contain
260 # letters, digits, spaces, hyphens and underscores and can be no longer
261 # than 30 characters. This is captured by the regular expression:
262 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "name": "A String", # Output only. The resource name of the Folder.
264 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]265 "parent": "A String", # Required. The Folder’s parent's resource name.
266 # Updates to the folder's parent must be performed via
267 # MoveFolder.
268 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 }</pre>
270</div>
271
272<div class="method">
273 <code class="details" id="get">get(name, x__xgafv=None)</code>
274 <pre>Retrieves a Folder identified by the supplied resource name.
275Valid Folder resource names have the format `folders/{folder_id}`
276(for example, `folders/1234`).
277The caller must have `resourcemanager.folders.get` permission on the
278identified folder.
279
280Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 name: string, Required. The resource name of the Folder to retrieve.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282Must be of the form `folders/{folder_id}`. (required)
283 x__xgafv: string, V1 error format.
284 Allowed values
285 1 - v1 error format
286 2 - v2 error format
287
288Returns:
289 An object of the form:
290
291 { # A Folder in an Organization's resource hierarchy, used to
292 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
294 # Updates to the lifecycle_state must be performed via
295 # DeleteFolder and
296 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "displayName": "A String", # The folder’s display name.
298 # A folder’s display name must be unique amongst its siblings, e.g.
299 # no two folders with the same parent can share the same display name.
300 # The display name must start and end with a letter or digit, may contain
301 # letters, digits, spaces, hyphens and underscores and can be no longer
302 # than 30 characters. This is captured by the regular expression:
303 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 "name": "A String", # Output only. The resource name of the Folder.
305 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "parent": "A String", # Required. The Folder’s parent's resource name.
307 # Updates to the folder's parent must be performed via
308 # MoveFolder.
309 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 }</pre>
311</div>
312
313<div class="method">
314 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
315 <pre>Gets the access control policy for a Folder. The returned policy may be
316empty if no such policy or resource exists. The `resource` field should
317be the Folder's resource name, e.g. "folders/1234".
318The caller must have `resourcemanager.folders.getIamPolicy` permission
319on the identified folder.
320
321Args:
322 resource: string, REQUIRED: The resource for which the policy is being requested.
323See the operation documentation for the appropriate value for this field. (required)
324 body: object, The request body.
325 The object takes the form of:
326
327{ # Request message for `GetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
329 # `GetIamPolicy`.
330 "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
331 #
332 # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
333 # rejected.
334 #
335 # Requests for policies with any conditional bindings must specify version 3.
336 # Policies without any conditional bindings may specify any valid value or
337 # leave the field unset.
338 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 }
340
341 x__xgafv: string, V1 error format.
342 Allowed values
343 1 - v1 error format
344 2 - v2 error format
345
346Returns:
347 An object of the form:
348
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349 { # An Identity and Access Management (IAM) policy, which specifies access
350 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 #
352 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]353 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
354 # `members` to a single `role`. Members can be user accounts, service accounts,
355 # Google groups, and domains (such as G Suite). A `role` is a named list of
356 # permissions; each `role` can be an IAM predefined role or a user-created
357 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 # Optionally, a `binding` can specify a `condition`, which is a logical
360 # expression that allows access to a resource only if the expression evaluates
361 # to `true`. A condition can add constraints based on attributes of the
362 # request, the resource, or both.
363 #
364 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 #
366 # {
367 # "bindings": [
368 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]369 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 # "members": [
371 # "user:mike@example.com",
372 # "group:admins@example.com",
373 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 # ]
376 # },
377 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]378 # "role": "roles/resourcemanager.organizationViewer",
379 # "members": ["user:eve@example.com"],
380 # "condition": {
381 # "title": "expirable access",
382 # "description": "Does not grant access after Sep 2020",
383 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
384 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]385 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 # ],
387 # "etag": "BwWWja0YfJA=",
388 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 # }
390 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]391 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 #
393 # bindings:
394 # - members:
395 # - user:mike@example.com
396 # - group:admins@example.com
397 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
399 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 # - user:eve@example.com
402 # role: roles/resourcemanager.organizationViewer
403 # condition:
404 # title: expirable access
405 # description: Does not grant access after Sep 2020
406 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
407 # - etag: BwWWja0YfJA=
408 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 #
410 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]411 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
413 { # Specifies the audit configuration for a service.
414 # The configuration determines which permission types are logged, and what
415 # identities, if any, are exempted from logging.
416 # An AuditConfig must have one or more AuditLogConfigs.
417 #
418 # If there are AuditConfigs for both `allServices` and a specific service,
419 # the union of the two AuditConfigs is used for that service: the log_types
420 # specified in each AuditConfig are enabled, and the exempted_members in each
421 # AuditLogConfig are exempted.
422 #
423 # Example Policy with multiple AuditConfigs:
424 #
425 # {
426 # "audit_configs": [
427 # {
428 # "service": "allServices"
429 # "audit_log_configs": [
430 # {
431 # "log_type": "DATA_READ",
432 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]433 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 # ]
435 # },
436 # {
437 # "log_type": "DATA_WRITE",
438 # },
439 # {
440 # "log_type": "ADMIN_READ",
441 # }
442 # ]
443 # },
444 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 # "audit_log_configs": [
447 # {
448 # "log_type": "DATA_READ",
449 # },
450 # {
451 # "log_type": "DATA_WRITE",
452 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 # ]
455 # }
456 # ]
457 # }
458 # ]
459 # }
460 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]461 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
462 # logging. It also exempts jose@example.com from DATA_READ logging, and
463 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 "auditLogConfigs": [ # The configuration for logging of each type of permission.
465 { # Provides the configuration for logging a type of permissions.
466 # Example:
467 #
468 # {
469 # "audit_log_configs": [
470 # {
471 # "log_type": "DATA_READ",
472 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]473 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]474 # ]
475 # },
476 # {
477 # "log_type": "DATA_WRITE",
478 # }
479 # ]
480 # }
481 #
482 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]483 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]484 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
485 # permission.
486 # Follows the same format of Binding.members.
487 "A String",
488 ],
489 "logType": "A String", # The log type that this config enables.
490 },
491 ],
492 "service": "A String", # Specifies a service that will be enabled for audit logging.
493 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
494 # `allServices` is a special value that covers all services.
495 },
496 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]497 "version": 42, # Specifies the format of the policy.
498 #
499 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
500 # are rejected.
501 #
502 # Any operation that affects conditional role bindings must specify version
503 # `3`. This requirement applies to the following operations:
504 #
505 # * Getting a policy that includes a conditional role binding
506 # * Adding a conditional role binding to a policy
507 # * Changing a conditional role binding in a policy
508 # * Removing any role binding, with or without a condition, from a policy
509 # that includes conditions
510 #
511 # **Important:** If you use IAM Conditions, you must include the `etag` field
512 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
513 # you to overwrite a version `3` policy with a version `1` policy, and all of
514 # the conditions in the version `3` policy are lost.
515 #
516 # If a policy does not include any conditions, operations on that policy may
517 # specify any valid version or leave the field unset.
518 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
519 # `condition` that determines how and when the `bindings` are applied. Each
520 # of the `bindings` must contain at least one member.
521 { # Associates `members` with a `role`.
522 "role": "A String", # Role that is assigned to `members`.
523 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
524 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
525 # NOTE: An unsatisfied condition will not allow user access via current
526 # binding. Different bindings, including their conditions, are examined
527 # independently.
528 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
529 # are documented at https://github.com/google/cel-spec.
530 #
531 # Example (Comparison):
532 #
533 # title: "Summary size limit"
534 # description: "Determines if a summary is less than 100 chars"
535 # expression: "document.summary.size() &lt; 100"
536 #
537 # Example (Equality):
538 #
539 # title: "Requestor is owner"
540 # description: "Determines if requestor is the document owner"
541 # expression: "document.owner == request.auth.claims.email"
542 #
543 # Example (Logic):
544 #
545 # title: "Public documents"
546 # description: "Determine whether the document should be publicly visible"
547 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
548 #
549 # Example (Data Manipulation):
550 #
551 # title: "Notification string"
552 # description: "Create a notification string with a timestamp."
553 # expression: "'New message received at ' + string(document.create_time)"
554 #
555 # The exact variables and functions that may be referenced within an expression
556 # are determined by the service that evaluates it. See the service
557 # documentation for additional information.
558 "description": "A String", # Optional. Description of the expression. This is a longer text which
559 # describes the expression, e.g. when hovered over it in a UI.
560 "expression": "A String", # Textual representation of an expression in Common Expression Language
561 # syntax.
562 "location": "A String", # Optional. String indicating the location of the expression for error
563 # reporting, e.g. a file name and a position in the file.
564 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
565 # its purpose. This can be used e.g. in UIs which allow to enter the
566 # expression.
567 },
568 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
569 # `members` can have the following values:
570 #
571 # * `allUsers`: A special identifier that represents anyone who is
572 # on the internet; with or without a Google account.
573 #
574 # * `allAuthenticatedUsers`: A special identifier that represents anyone
575 # who is authenticated with a Google account or a service account.
576 #
577 # * `user:{emailid}`: An email address that represents a specific Google
578 # account. For example, `alice@example.com` .
579 #
580 #
581 # * `serviceAccount:{emailid}`: An email address that represents a service
582 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
583 #
584 # * `group:{emailid}`: An email address that represents a Google group.
585 # For example, `admins@example.com`.
586 #
587 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
588 # identifier) representing a user that has been recently deleted. For
589 # example, `alice@example.com?uid=123456789012345678901`. If the user is
590 # recovered, this value reverts to `user:{emailid}` and the recovered user
591 # retains the role in the binding.
592 #
593 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
594 # unique identifier) representing a service account that has been recently
595 # deleted. For example,
596 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
597 # If the service account is undeleted, this value reverts to
598 # `serviceAccount:{emailid}` and the undeleted service account retains the
599 # role in the binding.
600 #
601 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
602 # identifier) representing a Google group that has been recently
603 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
604 # the group is recovered, this value reverts to `group:{emailid}` and the
605 # recovered group retains the role in the binding.
606 #
607 #
608 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
609 # users of that domain. For example, `google.com` or `example.com`.
610 #
611 "A String",
612 ],
613 },
614 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]615 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
616 # prevent simultaneous updates of a policy from overwriting each other.
617 # It is strongly suggested that systems make use of the `etag` in the
618 # read-modify-write cycle to perform policy updates in order to avoid race
619 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
620 # systems are expected to put that etag in the request to `setIamPolicy` to
621 # ensure that their change will be applied to the same version of the policy.
622 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]623 # **Important:** If you use IAM Conditions, you must include the `etag` field
624 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
625 # you to overwrite a version `3` policy with a version `1` policy, and all of
626 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]627 }</pre>
628</div>
629
630<div class="method">
631 <code class="details" id="list">list(parent=None, showDeleted=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
632 <pre>Lists the Folders that are direct descendants of supplied parent resource.
633List provides a strongly consistent view of the Folders underneath
634the specified parent resource.
635List returns Folders sorted based upon the (ascending) lexical ordering
636of their display_name.
637The caller must have `resourcemanager.folders.list` permission on the
638identified parent.
639
640Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]641 parent: string, Required. The resource name of the Organization or Folder whose Folders are
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]642being listed.
643Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
644Access to this method is controlled by checking the
645`resourcemanager.folders.list` permission on the `parent`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]646 showDeleted: boolean, Optional. Controls whether Folders in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]647DELETE_REQUESTED
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]648state should be returned. Defaults to false.
649 pageToken: string, Optional. A pagination token returned from a previous call to `ListFolders`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]650that indicates where this listing should continue from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]651 x__xgafv: string, V1 error format.
652 Allowed values
653 1 - v1 error format
654 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]655 pageSize: integer, Optional. The maximum number of Folders to return in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]656
657Returns:
658 An object of the form:
659
660 { # The ListFolders response message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661 "folders": [ # A possibly paginated list of Folders that are direct descendants of
662 # the specified parent resource.
663 { # A Folder in an Organization's resource hierarchy, used to
664 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]665 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
666 # Updates to the lifecycle_state must be performed via
667 # DeleteFolder and
668 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]669 "displayName": "A String", # The folder’s display name.
670 # A folder’s display name must be unique amongst its siblings, e.g.
671 # no two folders with the same parent can share the same display name.
672 # The display name must start and end with a letter or digit, may contain
673 # letters, digits, spaces, hyphens and underscores and can be no longer
674 # than 30 characters. This is captured by the regular expression:
675 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 "name": "A String", # Output only. The resource name of the Folder.
677 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]678 "parent": "A String", # Required. The Folder’s parent's resource name.
679 # Updates to the folder's parent must be performed via
680 # MoveFolder.
681 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]682 },
683 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684 "nextPageToken": "A String", # A pagination token returned from a previous call to `ListFolders`
685 # that indicates from where listing should continue.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]686 }</pre>
687</div>
688
689<div class="method">
690 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
691 <pre>Retrieves the next page of results.
692
693Args:
694 previous_request: The request for the previous page. (required)
695 previous_response: The response from the request for the previous page. (required)
696
697Returns:
698 A request object that you can call 'execute()' on to request the next
699 page. Returns None if there are no more items in the collection.
700 </pre>
701</div>
702
703<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]704 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 <pre>Moves a Folder under a new resource parent.
706Returns an Operation which can be used to track the progress of the
707folder move workflow.
708Upon success the Operation.response field will be populated with the
709moved Folder.
710Upon failure, a FolderOperationError categorizing the failure cause will
711be returned - if the failure occurs synchronously then the
712FolderOperationError will be returned via the Status.details field
713and if it occurs asynchronously then the FolderOperation will be returned
714via the Operation.error field.
715In addition, the Operation.metadata field will be populated with a
716FolderOperation message as an aid to stateless clients.
717Folder moves will be rejected if they violate either the naming, height
718or fanout constraints described in the
719CreateFolder documentation.
720The caller must have `resourcemanager.folders.move` permission on the
721folder's current and proposed new parent.
722
723Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]724 name: string, Required. The resource name of the Folder to move.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]725Must be of the form folders/{folder_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]727 The object takes the form of:
728
729{ # The MoveFolder request message.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]730 "destinationParent": "A String", # Required. The resource name of the Folder or Organization to reparent
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]731 # the folder under.
732 # Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
733 }
734
735 x__xgafv: string, V1 error format.
736 Allowed values
737 1 - v1 error format
738 2 - v2 error format
739
740Returns:
741 An object of the form:
742
743 { # This resource represents a long-running operation that is the result of a
744 # network API call.
745 "response": { # The normal response of the operation in case of success. If the original
746 # method returns no data on success, such as `Delete`, the response is
747 # `google.protobuf.Empty`. If the original method is standard
748 # `Get`/`Create`/`Update`, the response should be the resource. For other
749 # methods, the response should have the type `XxxResponse`, where `Xxx`
750 # is the original method name. For example, if the original method name
751 # is `TakeSnapshot()`, the inferred response type is
752 # `TakeSnapshotResponse`.
753 "a_key": "", # Properties of the object. Contains field @type with type URL.
754 },
755 "metadata": { # Service-specific metadata associated with the operation. It typically
756 # contains progress information and common metadata such as create time.
757 # Some services might not provide such metadata. Any method that returns a
758 # long-running operation should document the metadata type, if any.
759 "a_key": "", # Properties of the object. Contains field @type with type URL.
760 },
761 "done": True or False, # If the value is `false`, it means the operation is still in progress.
762 # If `true`, the operation is completed, and either `error` or `response` is
763 # available.
764 "name": "A String", # The server-assigned name, which is only unique within the same service that
765 # originally returns it. If you use the default HTTP mapping, the
766 # `name` should be a resource name ending with `operations/{unique_id}`.
767 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
768 # different programming environments, including REST APIs and RPC APIs. It is
769 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
770 # three pieces of data: error code, error message, and error details.
771 #
772 # You can find out more about this error model and how to work with it in the
773 # [API Design Guide](https://cloud.google.com/apis/design/errors).
774 "message": "A String", # A developer-facing error message, which should be in English. Any
775 # user-facing error message should be localized and sent in the
776 # google.rpc.Status.details field, or localized by the client.
777 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
778 "details": [ # A list of messages that carry the error details. There is a common set of
779 # message types for APIs to use.
780 {
781 "a_key": "", # Properties of the object. Contains field @type with type URL.
782 },
783 ],
784 },
785 }</pre>
786</div>
787
788<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]789 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]790 <pre>Updates a Folder, changing its display_name.
791Changes to the folder display_name will be rejected if they violate either
792the display_name formatting rules or naming constraints described in
793the CreateFolder documentation.
794
795The Folder's display name must start and end with a letter or digit,
796may contain letters, digits, spaces, hyphens and underscores and can be
797no longer than 30 characters. This is captured by the regular expression:
798[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
799The caller must have `resourcemanager.folders.update` permission on the
800identified folder.
801
802If the update fails due to the unique name constraint then a
803PreconditionFailure explaining this violation will be returned
804in the Status.details field.
805
806Args:
807 name: string, Output only. The resource name of the Folder.
808Its format is `folders/{folder_id}`, for example: "folders/1234". (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]809 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]810 The object takes the form of:
811
812{ # A Folder in an Organization's resource hierarchy, used to
813 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]814 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
815 # Updates to the lifecycle_state must be performed via
816 # DeleteFolder and
817 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]818 "displayName": "A String", # The folder’s display name.
819 # A folder’s display name must be unique amongst its siblings, e.g.
820 # no two folders with the same parent can share the same display name.
821 # The display name must start and end with a letter or digit, may contain
822 # letters, digits, spaces, hyphens and underscores and can be no longer
823 # than 30 characters. This is captured by the regular expression:
824 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825 "name": "A String", # Output only. The resource name of the Folder.
826 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]827 "parent": "A String", # Required. The Folder’s parent's resource name.
828 # Updates to the folder's parent must be performed via
829 # MoveFolder.
830 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]831}
832
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]833 updateMask: string, Required. Fields to be updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]834Only the `display_name` can be updated.
835 x__xgafv: string, V1 error format.
836 Allowed values
837 1 - v1 error format
838 2 - v2 error format
839
840Returns:
841 An object of the form:
842
843 { # A Folder in an Organization's resource hierarchy, used to
844 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]845 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
846 # Updates to the lifecycle_state must be performed via
847 # DeleteFolder and
848 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]849 "displayName": "A String", # The folder’s display name.
850 # A folder’s display name must be unique amongst its siblings, e.g.
851 # no two folders with the same parent can share the same display name.
852 # The display name must start and end with a letter or digit, may contain
853 # letters, digits, spaces, hyphens and underscores and can be no longer
854 # than 30 characters. This is captured by the regular expression:
855 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]856 "name": "A String", # Output only. The resource name of the Folder.
857 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]858 "parent": "A String", # Required. The Folder’s parent's resource name.
859 # Updates to the folder's parent must be performed via
860 # MoveFolder.
861 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]862 }</pre>
863</div>
864
865<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]866 <code class="details" id="search">search(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]867 <pre>Search for folders that match specific filter criteria.
868Search provides an eventually consistent view of the folders a user has
869access to which meet the specified filter criteria.
870
871This will only return folders on which the caller has the
872permission `resourcemanager.folders.get`.
873
874Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]875 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 The object takes the form of:
877
878{ # The request message for searching folders.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]879 "pageToken": "A String", # Optional. A pagination token returned from a previous call to `SearchFolders`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]880 # that indicates from where search should continue.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]881 "pageSize": 42, # Optional. The maximum number of folders to return in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]882 "query": "A String", # Search criteria used to select the Folders to return.
883 # If no search criteria is specified then all accessible folders will be
884 # returned.
885 #
886 # Query expressions can be used to restrict results based upon displayName,
887 # lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
888 # can be used along with the suffix wildcard symbol `*`.
889 #
890 # The displayName field in a query expression should use escaped quotes
891 # for values that include whitespace to prevent unexpected behavior.
892 #
893 # Some example queries are:
894 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]895 # * Query `displayName=Test*` returns Folder resources whose display name
896 # starts with "Test".
897 # * Query `lifecycleState=ACTIVE` returns Folder resources with
898 # `lifecycleState` set to `ACTIVE`.
899 # * Query `parent=folders/123` returns Folder resources that have
900 # `folders/123` as a parent resource.
901 # * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active
902 # Folder resources that have `folders/123` as a parent resource.
903 # * Query `displayName=\\"Test String\\"` returns Folder resources with
904 # display names that include both "Test" and "String".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]905 }
906
907 x__xgafv: string, V1 error format.
908 Allowed values
909 1 - v1 error format
910 2 - v2 error format
911
912Returns:
913 An object of the form:
914
915 { # The response message for searching folders.
916 "folders": [ # A possibly paginated folder search results.
917 # the specified parent resource.
918 { # A Folder in an Organization's resource hierarchy, used to
919 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]920 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
921 # Updates to the lifecycle_state must be performed via
922 # DeleteFolder and
923 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]924 "displayName": "A String", # The folder’s display name.
925 # A folder’s display name must be unique amongst its siblings, e.g.
926 # no two folders with the same parent can share the same display name.
927 # The display name must start and end with a letter or digit, may contain
928 # letters, digits, spaces, hyphens and underscores and can be no longer
929 # than 30 characters. This is captured by the regular expression:
930 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]931 "name": "A String", # Output only. The resource name of the Folder.
932 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]933 "parent": "A String", # Required. The Folder’s parent's resource name.
934 # Updates to the folder's parent must be performed via
935 # MoveFolder.
936 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]937 },
938 ],
939 "nextPageToken": "A String", # A pagination token returned from a previous call to `SearchFolders`
940 # that indicates from where searching should continue.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]941 }</pre>
942</div>
943
944<div class="method">
945 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
946 <pre>Retrieves the next page of results.
947
948Args:
949 previous_request: The request for the previous page. (required)
950 previous_response: The response from the request for the previous page. (required)
951
952Returns:
953 A request object that you can call 'execute()' on to request the next
954 page. Returns None if there are no more items in the collection.
955 </pre>
956</div>
957
958<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]959 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]960 <pre>Sets the access control policy on a Folder, replacing any existing policy.
961The `resource` field should be the Folder's resource name, e.g.
962"folders/1234".
963The caller must have `resourcemanager.folders.setIamPolicy` permission
964on the identified folder.
965
966Args:
967 resource: string, REQUIRED: The resource for which the policy is being specified.
968See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]969 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]970 The object takes the form of:
971
972{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]973 "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]974 # the policy is limited to a few 10s of KB. An empty policy is a
975 # valid policy but certain Cloud Platform services (such as Projects)
976 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]977 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 #
979 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]980 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
981 # `members` to a single `role`. Members can be user accounts, service accounts,
982 # Google groups, and domains (such as G Suite). A `role` is a named list of
983 # permissions; each `role` can be an IAM predefined role or a user-created
984 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]985 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]986 # Optionally, a `binding` can specify a `condition`, which is a logical
987 # expression that allows access to a resource only if the expression evaluates
988 # to `true`. A condition can add constraints based on attributes of the
989 # request, the resource, or both.
990 #
991 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]992 #
993 # {
994 # "bindings": [
995 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]996 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]997 # "members": [
998 # "user:mike@example.com",
999 # "group:admins@example.com",
1000 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1001 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1002 # ]
1003 # },
1004 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1005 # "role": "roles/resourcemanager.organizationViewer",
1006 # "members": ["user:eve@example.com"],
1007 # "condition": {
1008 # "title": "expirable access",
1009 # "description": "Does not grant access after Sep 2020",
1010 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1011 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1012 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1013 # ],
1014 # "etag": "BwWWja0YfJA=",
1015 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1016 # }
1017 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1018 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1019 #
1020 # bindings:
1021 # - members:
1022 # - user:mike@example.com
1023 # - group:admins@example.com
1024 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1025 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1026 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1027 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1028 # - user:eve@example.com
1029 # role: roles/resourcemanager.organizationViewer
1030 # condition:
1031 # title: expirable access
1032 # description: Does not grant access after Sep 2020
1033 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1034 # - etag: BwWWja0YfJA=
1035 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1036 #
1037 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1038 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1039 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1040 { # Specifies the audit configuration for a service.
1041 # The configuration determines which permission types are logged, and what
1042 # identities, if any, are exempted from logging.
1043 # An AuditConfig must have one or more AuditLogConfigs.
1044 #
1045 # If there are AuditConfigs for both `allServices` and a specific service,
1046 # the union of the two AuditConfigs is used for that service: the log_types
1047 # specified in each AuditConfig are enabled, and the exempted_members in each
1048 # AuditLogConfig are exempted.
1049 #
1050 # Example Policy with multiple AuditConfigs:
1051 #
1052 # {
1053 # "audit_configs": [
1054 # {
1055 # "service": "allServices"
1056 # "audit_log_configs": [
1057 # {
1058 # "log_type": "DATA_READ",
1059 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1060 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1061 # ]
1062 # },
1063 # {
1064 # "log_type": "DATA_WRITE",
1065 # },
1066 # {
1067 # "log_type": "ADMIN_READ",
1068 # }
1069 # ]
1070 # },
1071 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1072 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1073 # "audit_log_configs": [
1074 # {
1075 # "log_type": "DATA_READ",
1076 # },
1077 # {
1078 # "log_type": "DATA_WRITE",
1079 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1080 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1081 # ]
1082 # }
1083 # ]
1084 # }
1085 # ]
1086 # }
1087 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1088 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1089 # logging. It also exempts jose@example.com from DATA_READ logging, and
1090 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1091 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1092 { # Provides the configuration for logging a type of permissions.
1093 # Example:
1094 #
1095 # {
1096 # "audit_log_configs": [
1097 # {
1098 # "log_type": "DATA_READ",
1099 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1100 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1101 # ]
1102 # },
1103 # {
1104 # "log_type": "DATA_WRITE",
1105 # }
1106 # ]
1107 # }
1108 #
1109 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1110 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1111 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1112 # permission.
1113 # Follows the same format of Binding.members.
1114 "A String",
1115 ],
1116 "logType": "A String", # The log type that this config enables.
1117 },
1118 ],
1119 "service": "A String", # Specifies a service that will be enabled for audit logging.
1120 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1121 # `allServices` is a special value that covers all services.
1122 },
1123 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1124 "version": 42, # Specifies the format of the policy.
1125 #
1126 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1127 # are rejected.
1128 #
1129 # Any operation that affects conditional role bindings must specify version
1130 # `3`. This requirement applies to the following operations:
1131 #
1132 # * Getting a policy that includes a conditional role binding
1133 # * Adding a conditional role binding to a policy
1134 # * Changing a conditional role binding in a policy
1135 # * Removing any role binding, with or without a condition, from a policy
1136 # that includes conditions
1137 #
1138 # **Important:** If you use IAM Conditions, you must include the `etag` field
1139 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1140 # you to overwrite a version `3` policy with a version `1` policy, and all of
1141 # the conditions in the version `3` policy are lost.
1142 #
1143 # If a policy does not include any conditions, operations on that policy may
1144 # specify any valid version or leave the field unset.
1145 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1146 # `condition` that determines how and when the `bindings` are applied. Each
1147 # of the `bindings` must contain at least one member.
1148 { # Associates `members` with a `role`.
1149 "role": "A String", # Role that is assigned to `members`.
1150 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1151 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1152 # NOTE: An unsatisfied condition will not allow user access via current
1153 # binding. Different bindings, including their conditions, are examined
1154 # independently.
1155 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1156 # are documented at https://github.com/google/cel-spec.
1157 #
1158 # Example (Comparison):
1159 #
1160 # title: "Summary size limit"
1161 # description: "Determines if a summary is less than 100 chars"
1162 # expression: "document.summary.size() &lt; 100"
1163 #
1164 # Example (Equality):
1165 #
1166 # title: "Requestor is owner"
1167 # description: "Determines if requestor is the document owner"
1168 # expression: "document.owner == request.auth.claims.email"
1169 #
1170 # Example (Logic):
1171 #
1172 # title: "Public documents"
1173 # description: "Determine whether the document should be publicly visible"
1174 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1175 #
1176 # Example (Data Manipulation):
1177 #
1178 # title: "Notification string"
1179 # description: "Create a notification string with a timestamp."
1180 # expression: "'New message received at ' + string(document.create_time)"
1181 #
1182 # The exact variables and functions that may be referenced within an expression
1183 # are determined by the service that evaluates it. See the service
1184 # documentation for additional information.
1185 "description": "A String", # Optional. Description of the expression. This is a longer text which
1186 # describes the expression, e.g. when hovered over it in a UI.
1187 "expression": "A String", # Textual representation of an expression in Common Expression Language
1188 # syntax.
1189 "location": "A String", # Optional. String indicating the location of the expression for error
1190 # reporting, e.g. a file name and a position in the file.
1191 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1192 # its purpose. This can be used e.g. in UIs which allow to enter the
1193 # expression.
1194 },
1195 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1196 # `members` can have the following values:
1197 #
1198 # * `allUsers`: A special identifier that represents anyone who is
1199 # on the internet; with or without a Google account.
1200 #
1201 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1202 # who is authenticated with a Google account or a service account.
1203 #
1204 # * `user:{emailid}`: An email address that represents a specific Google
1205 # account. For example, `alice@example.com` .
1206 #
1207 #
1208 # * `serviceAccount:{emailid}`: An email address that represents a service
1209 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1210 #
1211 # * `group:{emailid}`: An email address that represents a Google group.
1212 # For example, `admins@example.com`.
1213 #
1214 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1215 # identifier) representing a user that has been recently deleted. For
1216 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1217 # recovered, this value reverts to `user:{emailid}` and the recovered user
1218 # retains the role in the binding.
1219 #
1220 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1221 # unique identifier) representing a service account that has been recently
1222 # deleted. For example,
1223 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1224 # If the service account is undeleted, this value reverts to
1225 # `serviceAccount:{emailid}` and the undeleted service account retains the
1226 # role in the binding.
1227 #
1228 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1229 # identifier) representing a Google group that has been recently
1230 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1231 # the group is recovered, this value reverts to `group:{emailid}` and the
1232 # recovered group retains the role in the binding.
1233 #
1234 #
1235 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1236 # users of that domain. For example, `google.com` or `example.com`.
1237 #
1238 "A String",
1239 ],
1240 },
1241 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1242 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1243 # prevent simultaneous updates of a policy from overwriting each other.
1244 # It is strongly suggested that systems make use of the `etag` in the
1245 # read-modify-write cycle to perform policy updates in order to avoid race
1246 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1247 # systems are expected to put that etag in the request to `setIamPolicy` to
1248 # ensure that their change will be applied to the same version of the policy.
1249 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1250 # **Important:** If you use IAM Conditions, you must include the `etag` field
1251 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1252 # you to overwrite a version `3` policy with a version `1` policy, and all of
1253 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1254 },
1255 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1256 # the fields in the mask will be modified. If no mask is provided, the
1257 # following default mask is used:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1258 #
1259 # `paths: "bindings, etag"`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1260 }
1261
1262 x__xgafv: string, V1 error format.
1263 Allowed values
1264 1 - v1 error format
1265 2 - v2 error format
1266
1267Returns:
1268 An object of the form:
1269
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1270 { # An Identity and Access Management (IAM) policy, which specifies access
1271 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1272 #
1273 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1274 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1275 # `members` to a single `role`. Members can be user accounts, service accounts,
1276 # Google groups, and domains (such as G Suite). A `role` is a named list of
1277 # permissions; each `role` can be an IAM predefined role or a user-created
1278 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1279 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1280 # Optionally, a `binding` can specify a `condition`, which is a logical
1281 # expression that allows access to a resource only if the expression evaluates
1282 # to `true`. A condition can add constraints based on attributes of the
1283 # request, the resource, or both.
1284 #
1285 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1286 #
1287 # {
1288 # "bindings": [
1289 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1290 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1291 # "members": [
1292 # "user:mike@example.com",
1293 # "group:admins@example.com",
1294 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1295 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1296 # ]
1297 # },
1298 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1299 # "role": "roles/resourcemanager.organizationViewer",
1300 # "members": ["user:eve@example.com"],
1301 # "condition": {
1302 # "title": "expirable access",
1303 # "description": "Does not grant access after Sep 2020",
1304 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1305 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1306 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1307 # ],
1308 # "etag": "BwWWja0YfJA=",
1309 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1310 # }
1311 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1312 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1313 #
1314 # bindings:
1315 # - members:
1316 # - user:mike@example.com
1317 # - group:admins@example.com
1318 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1319 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1320 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1321 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1322 # - user:eve@example.com
1323 # role: roles/resourcemanager.organizationViewer
1324 # condition:
1325 # title: expirable access
1326 # description: Does not grant access after Sep 2020
1327 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1328 # - etag: BwWWja0YfJA=
1329 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1330 #
1331 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1332 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1333 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1334 { # Specifies the audit configuration for a service.
1335 # The configuration determines which permission types are logged, and what
1336 # identities, if any, are exempted from logging.
1337 # An AuditConfig must have one or more AuditLogConfigs.
1338 #
1339 # If there are AuditConfigs for both `allServices` and a specific service,
1340 # the union of the two AuditConfigs is used for that service: the log_types
1341 # specified in each AuditConfig are enabled, and the exempted_members in each
1342 # AuditLogConfig are exempted.
1343 #
1344 # Example Policy with multiple AuditConfigs:
1345 #
1346 # {
1347 # "audit_configs": [
1348 # {
1349 # "service": "allServices"
1350 # "audit_log_configs": [
1351 # {
1352 # "log_type": "DATA_READ",
1353 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1354 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1355 # ]
1356 # },
1357 # {
1358 # "log_type": "DATA_WRITE",
1359 # },
1360 # {
1361 # "log_type": "ADMIN_READ",
1362 # }
1363 # ]
1364 # },
1365 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1366 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1367 # "audit_log_configs": [
1368 # {
1369 # "log_type": "DATA_READ",
1370 # },
1371 # {
1372 # "log_type": "DATA_WRITE",
1373 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1374 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1375 # ]
1376 # }
1377 # ]
1378 # }
1379 # ]
1380 # }
1381 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1382 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1383 # logging. It also exempts jose@example.com from DATA_READ logging, and
1384 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1385 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1386 { # Provides the configuration for logging a type of permissions.
1387 # Example:
1388 #
1389 # {
1390 # "audit_log_configs": [
1391 # {
1392 # "log_type": "DATA_READ",
1393 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1394 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1395 # ]
1396 # },
1397 # {
1398 # "log_type": "DATA_WRITE",
1399 # }
1400 # ]
1401 # }
1402 #
1403 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1404 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1405 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1406 # permission.
1407 # Follows the same format of Binding.members.
1408 "A String",
1409 ],
1410 "logType": "A String", # The log type that this config enables.
1411 },
1412 ],
1413 "service": "A String", # Specifies a service that will be enabled for audit logging.
1414 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1415 # `allServices` is a special value that covers all services.
1416 },
1417 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1418 "version": 42, # Specifies the format of the policy.
1419 #
1420 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1421 # are rejected.
1422 #
1423 # Any operation that affects conditional role bindings must specify version
1424 # `3`. This requirement applies to the following operations:
1425 #
1426 # * Getting a policy that includes a conditional role binding
1427 # * Adding a conditional role binding to a policy
1428 # * Changing a conditional role binding in a policy
1429 # * Removing any role binding, with or without a condition, from a policy
1430 # that includes conditions
1431 #
1432 # **Important:** If you use IAM Conditions, you must include the `etag` field
1433 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1434 # you to overwrite a version `3` policy with a version `1` policy, and all of
1435 # the conditions in the version `3` policy are lost.
1436 #
1437 # If a policy does not include any conditions, operations on that policy may
1438 # specify any valid version or leave the field unset.
1439 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1440 # `condition` that determines how and when the `bindings` are applied. Each
1441 # of the `bindings` must contain at least one member.
1442 { # Associates `members` with a `role`.
1443 "role": "A String", # Role that is assigned to `members`.
1444 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1445 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1446 # NOTE: An unsatisfied condition will not allow user access via current
1447 # binding. Different bindings, including their conditions, are examined
1448 # independently.
1449 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1450 # are documented at https://github.com/google/cel-spec.
1451 #
1452 # Example (Comparison):
1453 #
1454 # title: "Summary size limit"
1455 # description: "Determines if a summary is less than 100 chars"
1456 # expression: "document.summary.size() &lt; 100"
1457 #
1458 # Example (Equality):
1459 #
1460 # title: "Requestor is owner"
1461 # description: "Determines if requestor is the document owner"
1462 # expression: "document.owner == request.auth.claims.email"
1463 #
1464 # Example (Logic):
1465 #
1466 # title: "Public documents"
1467 # description: "Determine whether the document should be publicly visible"
1468 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1469 #
1470 # Example (Data Manipulation):
1471 #
1472 # title: "Notification string"
1473 # description: "Create a notification string with a timestamp."
1474 # expression: "'New message received at ' + string(document.create_time)"
1475 #
1476 # The exact variables and functions that may be referenced within an expression
1477 # are determined by the service that evaluates it. See the service
1478 # documentation for additional information.
1479 "description": "A String", # Optional. Description of the expression. This is a longer text which
1480 # describes the expression, e.g. when hovered over it in a UI.
1481 "expression": "A String", # Textual representation of an expression in Common Expression Language
1482 # syntax.
1483 "location": "A String", # Optional. String indicating the location of the expression for error
1484 # reporting, e.g. a file name and a position in the file.
1485 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1486 # its purpose. This can be used e.g. in UIs which allow to enter the
1487 # expression.
1488 },
1489 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1490 # `members` can have the following values:
1491 #
1492 # * `allUsers`: A special identifier that represents anyone who is
1493 # on the internet; with or without a Google account.
1494 #
1495 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1496 # who is authenticated with a Google account or a service account.
1497 #
1498 # * `user:{emailid}`: An email address that represents a specific Google
1499 # account. For example, `alice@example.com` .
1500 #
1501 #
1502 # * `serviceAccount:{emailid}`: An email address that represents a service
1503 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1504 #
1505 # * `group:{emailid}`: An email address that represents a Google group.
1506 # For example, `admins@example.com`.
1507 #
1508 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1509 # identifier) representing a user that has been recently deleted. For
1510 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1511 # recovered, this value reverts to `user:{emailid}` and the recovered user
1512 # retains the role in the binding.
1513 #
1514 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1515 # unique identifier) representing a service account that has been recently
1516 # deleted. For example,
1517 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1518 # If the service account is undeleted, this value reverts to
1519 # `serviceAccount:{emailid}` and the undeleted service account retains the
1520 # role in the binding.
1521 #
1522 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1523 # identifier) representing a Google group that has been recently
1524 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1525 # the group is recovered, this value reverts to `group:{emailid}` and the
1526 # recovered group retains the role in the binding.
1527 #
1528 #
1529 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1530 # users of that domain. For example, `google.com` or `example.com`.
1531 #
1532 "A String",
1533 ],
1534 },
1535 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1536 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1537 # prevent simultaneous updates of a policy from overwriting each other.
1538 # It is strongly suggested that systems make use of the `etag` in the
1539 # read-modify-write cycle to perform policy updates in order to avoid race
1540 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1541 # systems are expected to put that etag in the request to `setIamPolicy` to
1542 # ensure that their change will be applied to the same version of the policy.
1543 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1544 # **Important:** If you use IAM Conditions, you must include the `etag` field
1545 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1546 # you to overwrite a version `3` policy with a version `1` policy, and all of
1547 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1548 }</pre>
1549</div>
1550
1551<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1552 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1553 <pre>Returns permissions that a caller has on the specified Folder.
1554The `resource` field should be the Folder's resource name,
1555e.g. "folders/1234".
1556
1557There are no permissions required for making this API call.
1558
1559Args:
1560 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1561See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1562 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1563 The object takes the form of:
1564
1565{ # Request message for `TestIamPermissions` method.
1566 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1567 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1568 # information see
1569 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1570 "A String",
1571 ],
1572 }
1573
1574 x__xgafv: string, V1 error format.
1575 Allowed values
1576 1 - v1 error format
1577 2 - v2 error format
1578
1579Returns:
1580 An object of the form:
1581
1582 { # Response message for `TestIamPermissions` method.
1583 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1584 # allowed.
1585 "A String",
1586 ],
1587 }</pre>
1588</div>
1589
1590<div class="method">
1591 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
1592 <pre>Cancels the deletion request for a Folder. This method may only be
1593called on a Folder in the
1594DELETE_REQUESTED state.
1595In order to succeed, the Folder's parent must be in the
1596ACTIVE state.
1597In addition, reintroducing the folder into the tree must not violate
1598folder naming, height and fanout constraints described in the
1599CreateFolder documentation.
1600The caller must have `resourcemanager.folders.undelete` permission on the
1601identified folder.
1602
1603Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1604 name: string, Required. The resource name of the Folder to undelete.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1605Must be of the form `folders/{folder_id}`. (required)
1606 body: object, The request body.
1607 The object takes the form of:
1608
1609{ # The UndeleteFolder request message.
1610 }
1611
1612 x__xgafv: string, V1 error format.
1613 Allowed values
1614 1 - v1 error format
1615 2 - v2 error format
1616
1617Returns:
1618 An object of the form:
1619
1620 { # A Folder in an Organization's resource hierarchy, used to
1621 # organize that Organization's resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1622 "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
1623 # Updates to the lifecycle_state must be performed via
1624 # DeleteFolder and
1625 # UndeleteFolder.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1626 "displayName": "A String", # The folder’s display name.
1627 # A folder’s display name must be unique amongst its siblings, e.g.
1628 # no two folders with the same parent can share the same display name.
1629 # The display name must start and end with a letter or digit, may contain
1630 # letters, digits, spaces, hyphens and underscores and can be no longer
1631 # than 30 characters. This is captured by the regular expression:
1632 # [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1633 "name": "A String", # Output only. The resource name of the Folder.
1634 # Its format is `folders/{folder_id}`, for example: "folders/1234".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1635 "parent": "A String", # Required. The Folder’s parent's resource name.
1636 # Updates to the folder's parent must be performed via
1637 # MoveFolder.
1638 "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1639 }</pre>
1640</div>
1641
1642</body></html>