Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / dataproc_v1.projects.regions.operations.html
blob: 27484e9673f3db5becc79002ff37f00cf46aefdc [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.operations.html">operations</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
89<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]90 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]91<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]97<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <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]100<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105
106Args:
107 name: string, The name of the operation resource to be cancelled. (required)
108 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112
113Returns:
114 An object of the form:
115
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]116 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
117 # service Foo {
118 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
119 # }
120 # The JSON representation for Empty is empty JSON object {}.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 <pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn&#x27;t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]127
128Args:
129 name: string, The name of the operation resource to be deleted. (required)
130 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]134
135Returns:
136 An object of the form:
137
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
139 # service Foo {
140 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
141 # }
142 # The JSON representation for Empty is empty JSON object {}.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="get">get(name, x__xgafv=None)</code>
148 <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
149
150Args:
151 name: string, The name of the operation resource. (required)
152 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156
157Returns:
158 An object of the form:
159
160 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
163 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
165 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]167 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
169 &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
170 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
171 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
172 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]173 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]175 },
176 ],
177 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
183 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
184
185Args:
186 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
187 body: object, The request body.
188 The object takes the form of:
189
190{ # Request message for GetIamPolicy method.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]191 &quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
192 &quot;requestedPolicyVersion&quot;: 42, # Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]193 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 }
195
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]204 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
209 # &quot;members&quot;: [
210 # &quot;user:mike@example.com&quot;,
211 # &quot;group:admins@example.com&quot;,
212 # &quot;domain:google.com&quot;,
213 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 # ]
215 # },
216 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]218 # &quot;members&quot;: [
219 # &quot;user:eve@example.com&quot;
220 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 # &quot;condition&quot;: {
222 # &quot;title&quot;: &quot;expirable access&quot;,
223 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
224 # &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]225 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
229 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]231 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 # bindings:
233 # - members:
234 # - user:mike@example.com
235 # - group:admins@example.com
236 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]237 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
238 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]240 # - user:eve@example.com
241 # role: roles/resourcemanager.organizationViewer
242 # condition:
243 # title: expirable access
244 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 # - etag: BwWWja0YfJA=
247 # - version: 3
248 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]249 &quot;etag&quot;: &quot;A String&quot;, # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
250 &quot;version&quot;: 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
251 # Getting a policy that includes a conditional role binding
252 # Adding a conditional role binding to a policy
253 # Changing a conditional role binding in a policy
254 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 &quot;bindings&quot;: [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 { # Associates members with a role.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]257 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]258 # title: &quot;Summary size limit&quot;
259 # description: &quot;Determines if a summary is less than 100 chars&quot;
260 # expression: &quot;document.summary.size() &lt; 100&quot;
261 # Example (Equality):
262 # title: &quot;Requestor is owner&quot;
263 # description: &quot;Determines if requestor is the document owner&quot;
264 # expression: &quot;document.owner == request.auth.claims.email&quot;
265 # Example (Logic):
266 # title: &quot;Public documents&quot;
267 # description: &quot;Determine whether the document should be publicly visible&quot;
268 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
269 # Example (Data Manipulation):
270 # title: &quot;Notification string&quot;
271 # description: &quot;Create a notification string with a timestamp.&quot;
272 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
273 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
274 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
275 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
276 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
277 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
278 },
279 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
281 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
284 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]285 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
286 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
287 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]291 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 },
293 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 }</pre>
295</div>
296
297<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]298 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]299 <pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300
301Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]303 filter: string, The standard list filter.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]304 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 pageSize: integer, The standard list page size.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]306 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310
311Returns:
312 An object of the form:
313
314 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]316 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]317 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
318 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
319 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]320 &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
321 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
322 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]323 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
325 &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
326 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
327 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
328 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]329 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]330 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]331 },
332 ],
333 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]334 },
335 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
342 <pre>Retrieves the next page of results.
343
344Args:
345 previous_request: The request for the previous page. (required)
346 previous_response: The response from the request for the previous page. (required)
347
348Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]349 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]350 page. Returns None if there are no more items in the collection.
351 </pre>
352</div>
353
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]355 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]356 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357
358Args:
359 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 The object takes the form of:
362
363{ # Request message for SetIamPolicy method.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]364 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]366 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]367 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]368 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
369 # &quot;members&quot;: [
370 # &quot;user:mike@example.com&quot;,
371 # &quot;group:admins@example.com&quot;,
372 # &quot;domain:google.com&quot;,
373 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 # ]
375 # },
376 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]377 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]378 # &quot;members&quot;: [
379 # &quot;user:eve@example.com&quot;
380 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]381 # &quot;condition&quot;: {
382 # &quot;title&quot;: &quot;expirable access&quot;,
383 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
384 # &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]385 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]387 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
389 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]391 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 # bindings:
393 # - members:
394 # - user:mike@example.com
395 # - group:admins@example.com
396 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]397 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
398 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]400 # - user:eve@example.com
401 # role: roles/resourcemanager.organizationViewer
402 # condition:
403 # title: expirable access
404 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]405 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]406 # - etag: BwWWja0YfJA=
407 # - version: 3
408 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]409 &quot;etag&quot;: &quot;A String&quot;, # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
410 &quot;version&quot;: 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
411 # Getting a policy that includes a conditional role binding
412 # Adding a conditional role binding to a policy
413 # Changing a conditional role binding in a policy
414 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]415 &quot;bindings&quot;: [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 { # Associates members with a role.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]417 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]418 # title: &quot;Summary size limit&quot;
419 # description: &quot;Determines if a summary is less than 100 chars&quot;
420 # expression: &quot;document.summary.size() &lt; 100&quot;
421 # Example (Equality):
422 # title: &quot;Requestor is owner&quot;
423 # description: &quot;Determines if requestor is the document owner&quot;
424 # expression: &quot;document.owner == request.auth.claims.email&quot;
425 # Example (Logic):
426 # title: &quot;Public documents&quot;
427 # description: &quot;Determine whether the document should be publicly visible&quot;
428 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
429 # Example (Data Manipulation):
430 # title: &quot;Notification string&quot;
431 # description: &quot;Create a notification string with a timestamp.&quot;
432 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
433 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
434 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
435 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
436 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
437 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
438 },
439 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
441 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]442 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
444 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]445 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
446 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
447 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]449 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]451 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 },
453 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 },
455 }
456
457 x__xgafv: string, V1 error format.
458 Allowed values
459 1 - v1 error format
460 2 - v2 error format
461
462Returns:
463 An object of the form:
464
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]465 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]467 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]469 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
470 # &quot;members&quot;: [
471 # &quot;user:mike@example.com&quot;,
472 # &quot;group:admins@example.com&quot;,
473 # &quot;domain:google.com&quot;,
474 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]475 # ]
476 # },
477 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]478 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]479 # &quot;members&quot;: [
480 # &quot;user:eve@example.com&quot;
481 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]482 # &quot;condition&quot;: {
483 # &quot;title&quot;: &quot;expirable access&quot;,
484 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
485 # &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]486 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]488 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]489 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
490 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]492 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 # bindings:
494 # - members:
495 # - user:mike@example.com
496 # - group:admins@example.com
497 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]498 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
499 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]501 # - user:eve@example.com
502 # role: roles/resourcemanager.organizationViewer
503 # condition:
504 # title: expirable access
505 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]506 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]507 # - etag: BwWWja0YfJA=
508 # - version: 3
509 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]510 &quot;etag&quot;: &quot;A String&quot;, # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
511 &quot;version&quot;: 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
512 # Getting a policy that includes a conditional role binding
513 # Adding a conditional role binding to a policy
514 # Changing a conditional role binding in a policy
515 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]516 &quot;bindings&quot;: [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 { # Associates members with a role.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]518 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]519 # title: &quot;Summary size limit&quot;
520 # description: &quot;Determines if a summary is less than 100 chars&quot;
521 # expression: &quot;document.summary.size() &lt; 100&quot;
522 # Example (Equality):
523 # title: &quot;Requestor is owner&quot;
524 # description: &quot;Determines if requestor is the document owner&quot;
525 # expression: &quot;document.owner == request.auth.claims.email&quot;
526 # Example (Logic):
527 # title: &quot;Public documents&quot;
528 # description: &quot;Determine whether the document should be publicly visible&quot;
529 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
530 # Example (Data Manipulation):
531 # title: &quot;Notification string&quot;
532 # description: &quot;Create a notification string with a timestamp.&quot;
533 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
534 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
535 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
536 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
537 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
538 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
539 },
540 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]541 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
542 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]543 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
545 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]546 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
547 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
548 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]549 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]550 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]552 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 },
554 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555 }</pre>
556</div>
557
558<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]559 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]560 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may &quot;fail open&quot; without warning.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561
562Args:
563 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]564 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565 The object takes the form of:
566
567{ # Request message for TestIamPermissions method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]568 &quot;permissions&quot;: [ # The set of permissions to check for the resource. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
569 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]570 ],
571 }
572
573 x__xgafv: string, V1 error format.
574 Allowed values
575 1 - v1 error format
576 2 - v2 error format
577
578Returns:
579 An object of the form:
580
581 { # Response message for TestIamPermissions method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]582 &quot;permissions&quot;: [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
583 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 ],
585 }</pre>
586</div>
587
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]588</body></html>