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