Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / dataproc_v1.projects.regions.operations.html
blob: 31bc62f2aad02ab7ccc6673cc8d6c30fa8143cd8 [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">
90 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=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">
96 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
98<p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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'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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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'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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]162 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "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.
165 "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.
166 "a_key": "", # Properties of the object. Contains field @type with type URL.
167 },
168 "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}.
169 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 "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.
171 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "details": [ # 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 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]174 "a_key": "", # 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.
191 }
192
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198Returns:
199 An object of the form:
200
201 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
202 # {
203 # "bindings": [
204 # {
205 # "role": "roles/owner",
206 # "members": [
207 # "user:mike@example.com",
208 # "group:admins@example.com",
209 # "domain:google.com",
210 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
211 # ]
212 # },
213 # {
214 # "role": "roles/viewer",
215 # "members": ["user:sean@example.com"]
216 # }
217 # ]
218 # }
219 # YAML Example
220 # bindings:
221 # - members:
222 # - user:mike@example.com
223 # - group:admins@example.com
224 # - domain:google.com
225 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
226 # role: roles/owner
227 # - members:
228 # - user:sean@example.com
229 # role: roles/viewer
230 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
231 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
232 { # Associates members with a role.
233 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
234 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
235 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
236 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
237 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
238 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
239 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
240 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
241 "A String",
242 ],
243 "condition": { # Represents an expression text. Example: # 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.
244 # title: "User account presence"
245 # description: "Determines whether the request has a user account"
246 # expression: "size(request.user) > 0"
247 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
248 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
249 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
250 "title": "A String", # An 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.
251 },
252 },
253 ],
254 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
255 "version": 42, # Deprecated.
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]261 <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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]262
263Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]264 name: string, The name of the operation's parent resource. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]265 pageToken: string, The standard list page token.
266 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 pageSize: integer, The standard list page size.
271 filter: string, The standard list filter.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272
273Returns:
274 An object of the form:
275
276 { # The response message for Operations.ListOperations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]277 "nextPageToken": "A String", # The standard List next-page token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]278 "operations": [ # A list of operations that matches the specified filter in the request.
279 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]280 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]281 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]282 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 "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.
284 "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.
285 "a_key": "", # Properties of the object. Contains field @type with type URL.
286 },
287 "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}.
288 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]289 "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.
290 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 "details": [ # 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]292 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]293 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]294 },
295 ],
296 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]297 },
298 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
304 <pre>Retrieves the next page of results.
305
306Args:
307 previous_request: The request for the previous page. (required)
308 previous_response: The response from the request for the previous page. (required)
309
310Returns:
311 A request object that you can call 'execute()' on to request the next
312 page. Returns None if there are no more items in the collection.
313 </pre>
314</div>
315
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316<div class="method">
317 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
318 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
319
320Args:
321 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
322 body: object, The request body. (required)
323 The object takes the form of:
324
325{ # Request message for SetIamPolicy method.
326 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.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.
327 # {
328 # "bindings": [
329 # {
330 # "role": "roles/owner",
331 # "members": [
332 # "user:mike@example.com",
333 # "group:admins@example.com",
334 # "domain:google.com",
335 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
336 # ]
337 # },
338 # {
339 # "role": "roles/viewer",
340 # "members": ["user:sean@example.com"]
341 # }
342 # ]
343 # }
344 # YAML Example
345 # bindings:
346 # - members:
347 # - user:mike@example.com
348 # - group:admins@example.com
349 # - domain:google.com
350 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
351 # role: roles/owner
352 # - members:
353 # - user:sean@example.com
354 # role: roles/viewer
355 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
356 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
357 { # Associates members with a role.
358 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
359 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
360 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
361 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
362 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
363 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
364 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
365 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
366 "A String",
367 ],
368 "condition": { # Represents an expression text. Example: # 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.
369 # title: "User account presence"
370 # description: "Determines whether the request has a user account"
371 # expression: "size(request.user) > 0"
372 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
373 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
374 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
375 "title": "A String", # An 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.
376 },
377 },
378 ],
379 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
380 "version": 42, # Deprecated.
381 },
382 }
383
384 x__xgafv: string, V1 error format.
385 Allowed values
386 1 - v1 error format
387 2 - v2 error format
388
389Returns:
390 An object of the form:
391
392 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
393 # {
394 # "bindings": [
395 # {
396 # "role": "roles/owner",
397 # "members": [
398 # "user:mike@example.com",
399 # "group:admins@example.com",
400 # "domain:google.com",
401 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
402 # ]
403 # },
404 # {
405 # "role": "roles/viewer",
406 # "members": ["user:sean@example.com"]
407 # }
408 # ]
409 # }
410 # YAML Example
411 # bindings:
412 # - members:
413 # - user:mike@example.com
414 # - group:admins@example.com
415 # - domain:google.com
416 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
417 # role: roles/owner
418 # - members:
419 # - user:sean@example.com
420 # role: roles/viewer
421 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
422 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
423 { # Associates members with a role.
424 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
425 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
426 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
427 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
428 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
429 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
430 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
431 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
432 "A String",
433 ],
434 "condition": { # Represents an expression text. Example: # 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.
435 # title: "User account presence"
436 # description: "Determines whether the request has a user account"
437 # expression: "size(request.user) > 0"
438 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
439 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
440 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
441 "title": "A String", # An 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.
442 },
443 },
444 ],
445 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
446 "version": 42, # Deprecated.
447 }</pre>
448</div>
449
450<div class="method">
451 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
452 <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.
453
454Args:
455 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)
456 body: object, The request body. (required)
457 The object takes the form of:
458
459{ # Request message for TestIamPermissions method.
460 "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).
461 "A String",
462 ],
463 }
464
465 x__xgafv: string, V1 error format.
466 Allowed values
467 1 - v1 error format
468 2 - v2 error format
469
470Returns:
471 An object of the form:
472
473 { # Response message for TestIamPermissions method.
474 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
475 "A String",
476 ],
477 }</pre>
478</div>
479
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]480</body></html>