Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dataproc_v1beta2.projects.regions.operations.html
blob: b38daf4f68db0d699d9baa03a19629719ca5f1fd [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="dataproc_v1beta2.html">Cloud Dataproc API</a> . <a href="dataproc_v1beta2.projects.html">projects</a> . <a href="dataproc_v1beta2.projects.regions.html">regions</a> . <a href="dataproc_v1beta2.projects.regions.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
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>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
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>
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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
90 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
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>
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="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED</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>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
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'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.
105
106Args:
107 name: string, The name of the operation resource to be cancelled. (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
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 {}.
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
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't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
127
128Args:
129 name: string, The name of the operation resource to be deleted. (required)
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
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 {}.
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.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL.
163 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "error": { # 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.
165 "message": "A String", # 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.
166 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
167 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
168 {
169 "a_key": "", # Properties of the object. Contains field @type with type URL.
170 },
171 ],
172 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 "done": 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.
174 "response": { # 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.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
177 "name": "A String", # 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}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187 options_requestedPolicyVersion: integer, 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 { # 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.Optionally, a binding can 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.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 # {
198 # "bindings": [
199 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 # "members": [
202 # "user:mike@example.com",
203 # "group:admins@example.com",
204 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 # ]
207 # },
208 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]209 # "role": "roles/resourcemanager.organizationViewer",
210 # "members": ["user:eve@example.com"],
211 # "condition": {
212 # "title": "expirable access",
213 # "description": "Does not grant access after Sep 2020",
214 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
215 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 # ],
218 # "etag": "BwWWja0YfJA=",
219 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]221 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 # bindings:
223 # - members:
224 # - user:mike@example.com
225 # - group:admins@example.com
226 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
228 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]230 # - user:eve@example.com
231 # role: roles/resourcemanager.organizationViewer
232 # condition:
233 # title: expirable access
234 # description: Does not grant access after Sep 2020
235 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
236 # - etag: BwWWja0YfJA=
237 # - version: 3
238 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
239 "bindings": [ # 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]240 { # Associates members with a role.
241 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
242 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
243 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
244 # 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^]245 # 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]246 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
247 # 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^]248 # 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.
249 # 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.
250 # 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]251 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
252 "A String",
253 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 "condition": { # 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. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
255 # title: "Summary size limit"
256 # description: "Determines if a summary is less than 100 chars"
257 # expression: "document.summary.size() &lt; 100"
258 # Example (Equality):
259 # title: "Requestor is owner"
260 # description: "Determines if requestor is the document owner"
261 # expression: "document.owner == request.auth.claims.email"
262 # Example (Logic):
263 # title: "Public documents"
264 # description: "Determine whether the document should be publicly visible"
265 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
266 # Example (Data Manipulation):
267 # title: "Notification string"
268 # description: "Create a notification string with a timestamp."
269 # expression: "'New message received at ' + string(document.create_time)"
270 # 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.
271 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
272 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
273 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
274 "title": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 },
276 },
277 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 "etag": "A String", # 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.
279 "version": 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:
280 # Getting a policy that includes a conditional role binding
281 # Adding a conditional role binding to a policy
282 # Changing a conditional role binding in a policy
283 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 }</pre>
285</div>
286
287<div class="method">
288 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
289 <pre>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.
290
291Args:
292 name: string, The name of the operation's parent resource. (required)
293 pageToken: string, The standard list page token.
294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
298 pageSize: integer, The standard list page size.
299 filter: string, The standard list filter.
300
301Returns:
302 An object of the form:
303
304 { # The response message for Operations.ListOperations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 "operations": [ # A list of operations that matches the specified filter in the request.
306 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 "metadata": { # 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.
308 "a_key": "", # Properties of the object. Contains field @type with type URL.
309 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 "error": { # 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.
311 "message": "A String", # 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.
312 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
313 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
314 {
315 "a_key": "", # Properties of the object. Contains field @type with type URL.
316 },
317 ],
318 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319 "done": 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.
320 "response": { # 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.
321 "a_key": "", # Properties of the object. Contains field @type with type URL.
322 },
323 "name": "A String", # 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}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 },
325 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]326 "nextPageToken": "A String", # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
332 <pre>Retrieves the next page of results.
333
334Args:
335 previous_request: The request for the previous page. (required)
336 previous_response: The response from the request for the previous page. (required)
337
338Returns:
339 A request object that you can call 'execute()' on to request the next
340 page. Returns None if there are no more items in the collection.
341 </pre>
342</div>
343
344<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
346 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347
348Args:
349 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^]350 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 The object takes the form of:
352
353{ # Request message for SetIamPolicy method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "policy": { # 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.Optionally, a binding can 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.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]355 # {
356 # "bindings": [
357 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 # "members": [
360 # "user:mike@example.com",
361 # "group:admins@example.com",
362 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 # ]
365 # },
366 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 # "role": "roles/resourcemanager.organizationViewer",
368 # "members": ["user:eve@example.com"],
369 # "condition": {
370 # "title": "expirable access",
371 # "description": "Does not grant access after Sep 2020",
372 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
373 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]375 # ],
376 # "etag": "BwWWja0YfJA=",
377 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 # bindings:
381 # - members:
382 # - user:mike@example.com
383 # - group:admins@example.com
384 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]385 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
386 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 # - user:eve@example.com
389 # role: roles/resourcemanager.organizationViewer
390 # condition:
391 # title: expirable access
392 # description: Does not grant access after Sep 2020
393 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
394 # - etag: BwWWja0YfJA=
395 # - version: 3
396 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
397 "bindings": [ # 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]398 { # Associates members with a role.
399 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
400 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
401 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
402 # 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^]403 # 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]404 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
405 # 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^]406 # 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.
407 # 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.
408 # 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]409 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
410 "A String",
411 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "condition": { # 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. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
413 # title: "Summary size limit"
414 # description: "Determines if a summary is less than 100 chars"
415 # expression: "document.summary.size() &lt; 100"
416 # Example (Equality):
417 # title: "Requestor is owner"
418 # description: "Determines if requestor is the document owner"
419 # expression: "document.owner == request.auth.claims.email"
420 # Example (Logic):
421 # title: "Public documents"
422 # description: "Determine whether the document should be publicly visible"
423 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
424 # Example (Data Manipulation):
425 # title: "Notification string"
426 # description: "Create a notification string with a timestamp."
427 # expression: "'New message received at ' + string(document.create_time)"
428 # 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.
429 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
430 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
431 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
432 "title": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 },
434 },
435 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "etag": "A String", # 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.
437 "version": 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:
438 # Getting a policy that includes a conditional role binding
439 # Adding a conditional role binding to a policy
440 # Changing a conditional role binding in a policy
441 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 },
443 }
444
445 x__xgafv: string, V1 error format.
446 Allowed values
447 1 - v1 error format
448 2 - v2 error format
449
450Returns:
451 An object of the form:
452
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 { # 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.Optionally, a binding can 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.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 # {
455 # "bindings": [
456 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]457 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 # "members": [
459 # "user:mike@example.com",
460 # "group:admins@example.com",
461 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 # ]
464 # },
465 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 # "role": "roles/resourcemanager.organizationViewer",
467 # "members": ["user:eve@example.com"],
468 # "condition": {
469 # "title": "expirable access",
470 # "description": "Does not grant access after Sep 2020",
471 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
472 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]473 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]474 # ],
475 # "etag": "BwWWja0YfJA=",
476 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]477 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]478 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 # bindings:
480 # - members:
481 # - user:mike@example.com
482 # - group:admins@example.com
483 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
485 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 # - user:eve@example.com
488 # role: roles/resourcemanager.organizationViewer
489 # condition:
490 # title: expirable access
491 # description: Does not grant access after Sep 2020
492 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
493 # - etag: BwWWja0YfJA=
494 # - version: 3
495 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
496 "bindings": [ # 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]497 { # Associates members with a role.
498 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
499 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
500 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
501 # 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^]502 # 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]503 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
504 # 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^]505 # 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.
506 # 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.
507 # 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]508 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
509 "A String",
510 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]511 "condition": { # 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. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
512 # title: "Summary size limit"
513 # description: "Determines if a summary is less than 100 chars"
514 # expression: "document.summary.size() &lt; 100"
515 # Example (Equality):
516 # title: "Requestor is owner"
517 # description: "Determines if requestor is the document owner"
518 # expression: "document.owner == request.auth.claims.email"
519 # Example (Logic):
520 # title: "Public documents"
521 # description: "Determine whether the document should be publicly visible"
522 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
523 # Example (Data Manipulation):
524 # title: "Notification string"
525 # description: "Create a notification string with a timestamp."
526 # expression: "'New message received at ' + string(document.create_time)"
527 # 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.
528 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
529 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
530 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
531 "title": "A String", # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 },
533 },
534 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]535 "etag": "A String", # 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.
536 "version": 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:
537 # Getting a policy that includes a conditional role binding
538 # Adding a conditional role binding to a policy
539 # Changing a conditional role binding in a policy
540 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]541 }</pre>
542</div>
543
544<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]546 <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 "fail open" without warning.
547
548Args:
549 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^]550 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 The object takes the form of:
552
553{ # Request message for TestIamPermissions method.
554 "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
555 "A String",
556 ],
557 }
558
559 x__xgafv: string, V1 error format.
560 Allowed values
561 1 - v1 error format
562 2 - v2 error format
563
564Returns:
565 An object of the form:
566
567 { # Response message for TestIamPermissions method.
568 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
569 "A String",
570 ],
571 }</pre>
572</div>
573
574</body></html>