Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / pubsub_v1beta2.projects.topics.html
blob: 9898eaa91b6d0a9ad7d4bd21b9a8b17e52bc3efe [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -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
75<h1><a href="pubsub_v1beta2.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.topics.html">topics</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="pubsub_v1beta2.projects.topics.subscriptions.html">subscriptions()</a></code>
79</p>
80<p class="firstline">Returns the subscriptions Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]83 <code><a href="#create">create(name=None, body, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]84<p class="firstline">Creates the given topic with the given name.</p>
85<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86 <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]87<p class="firstline">Deletes the topic with the given name. Returns `NOT_FOUND` if the topic</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]88<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]89 <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]90<p class="firstline">Gets the configuration of a topic.</p>
91<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]92 <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets the access control policy for a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]94<p class="toc_element">
95 <code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]96<p class="firstline">Lists matching topics.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]101 <code><a href="#publish">publish(topic, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]102<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]103<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]104 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
105<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]106<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]107 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]108<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]109<h3>Method Details</h3>
110<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]111 <code class="details" id="create">create(name=None, body, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]112 <pre>Creates the given topic with the given name.
113
114Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]115 name: string, The name of the topic. It must have the format
116`"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
117and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
118underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
119signs (`%`). It must be between 3 and 255 characters in length, and it
120must not start with `"goog"`. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121 body: object, The request body. (required)
122 The object takes the form of:
123
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124{ # A topic resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]125 "name": "A String", # The name of the topic. It must have the format
126 # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
127 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
128 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
129 # signs (`%`). It must be between 3 and 255 characters in length, and it
130 # must not start with `"goog"`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]131}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]132
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]133 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137
138Returns:
139 An object of the form:
140
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]141 { # A topic resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]142 "name": "A String", # The name of the topic. It must have the format
143 # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
144 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
145 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
146 # signs (`%`). It must be between 3 and 255 characters in length, and it
147 # must not start with `"goog"`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]152 <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]153 <pre>Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
154does not exist. After a topic is deleted, a new topic may be created with
155the same name; this is an entirely new topic with none of the old
156configuration or subscriptions. Existing subscriptions to this topic are
157not deleted, but their `topic` field is set to `_deleted-topic_`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]158
159Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]160 topic: string, Name of the topic to delete. (required)
161 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]165
166Returns:
167 An object of the form:
168
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]169 { # A generic empty message that you can re-use to avoid defining duplicated
170 # empty messages in your APIs. A typical example is to use it as the request
171 # or the response type of an API method. For instance:
172 #
173 # service Foo {
174 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
175 # }
176 #
177 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]178 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]179</div>
180
181<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]182 <code class="details" id="get">get(topic, x__xgafv=None)</code>
183 <pre>Gets the configuration of a topic.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]184
185Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]186 topic: string, The name of the topic to get. (required)
187 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]191
192Returns:
193 An object of the form:
194
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]195 { # A topic resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]196 "name": "A String", # The name of the topic. It must have the format
197 # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
198 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
199 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
200 # signs (`%`). It must be between 3 and 255 characters in length, and it
201 # must not start with `"goog"`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]202 }</pre>
203</div>
204
205<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]206 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
207 <pre>Gets the access control policy for a resource.
208Returns an empty policy if the resource exists and does not have a policy
209set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]210
211Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]212 resource: string, REQUIRED: The resource for which the policy is being requested.
213`resource` is usually specified as a path. For example, a Project
214resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]215 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]219
220Returns:
221 An object of the form:
222
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]223 { # Defines an Identity and Access Management (IAM) policy. It is used to
224 # specify access control policies for Cloud Platform resources.
225 #
226 #
227 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
228 # `members` to a `role`, where the members can be user accounts, Google groups,
229 # Google domains, and service accounts. A `role` is a named list of permissions
230 # defined by IAM.
231 #
232 # **Example**
233 #
234 # {
235 # "bindings": [
236 # {
237 # "role": "roles/owner",
238 # "members": [
239 # "user:mike@example.com",
240 # "group:admins@example.com",
241 # "domain:google.com",
242 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
243 # ]
244 # },
245 # {
246 # "role": "roles/viewer",
247 # "members": ["user:sean@example.com"]
248 # }
249 # ]
250 # }
251 #
252 # For a description of IAM and its features, see the
253 # [IAM developer's guide](https://cloud.google.com/iam).
254 "bindings": [ # Associates a list of `members` to a `role`.
255 # Multiple `bindings` must not be specified for the same `role`.
256 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]257 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]258 "role": "A String", # Role that is assigned to `members`.
259 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
260 # Required
261 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
262 # `members` can have the following values:
263 #
264 # * `allUsers`: A special identifier that represents anyone who is
265 # on the internet; with or without a Google account.
266 #
267 # * `allAuthenticatedUsers`: A special identifier that represents anyone
268 # who is authenticated with a Google account or a service account.
269 #
270 # * `user:{emailid}`: An email address that represents a specific Google
271 # account. For example, `alice@gmail.com` or `joe@example.com`.
272 #
273 #
274 # * `serviceAccount:{emailid}`: An email address that represents a service
275 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
276 #
277 # * `group:{emailid}`: An email address that represents a Google group.
278 # For example, `admins@example.com`.
279 #
280 # * `domain:{domain}`: A Google Apps domain name that represents all the
281 # users of that domain. For example, `google.com` or `example.com`.
282 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]283 "A String",
284 ],
285 },
286 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]287 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
288 # prevent simultaneous updates of a policy from overwriting each other.
289 # It is strongly suggested that systems make use of the `etag` in the
290 # read-modify-write cycle to perform policy updates in order to avoid race
291 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
292 # systems are expected to put that etag in the request to `setIamPolicy` to
293 # ensure that their change will be applied to the same version of the policy.
294 #
295 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
296 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]297 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
303 <pre>Lists matching topics.
304
305Args:
306 project: string, The name of the cloud project that topics belong to. (required)
307 pageSize: integer, Maximum number of topics to return.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]308 pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is
309a continuation of a prior `ListTopics` call, and that the system should
310return the next page of data.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]311 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]315
316Returns:
317 An object of the form:
318
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]319 { # Response for the `ListTopics` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]320 "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the
321 # request; this value should be passed in a new `ListTopicsRequest`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]322 "topics": [ # The resulting topics.
323 { # A topic resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]324 "name": "A String", # The name of the topic. It must have the format
325 # `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
326 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
327 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
328 # signs (`%`). It must be between 3 and 255 characters in length, and it
329 # must not start with `"goog"`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]330 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]331 ],
332 }</pre>
333</div>
334
335<div class="method">
336 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
337 <pre>Retrieves the next page of results.
338
339Args:
340 previous_request: The request for the previous page. (required)
341 previous_response: The response from the request for the previous page. (required)
342
343Returns:
344 A request object that you can call 'execute()' on to request the next
345 page. Returns None if there are no more items in the collection.
346 </pre>
347</div>
348
349<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]350 <code class="details" id="publish">publish(topic, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]351 <pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
352does not exist. The message payload must not be empty; it must contain
353 either a non-empty data field, or at least one attribute.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]354
355Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]356 topic: string, The messages in the request will be published on this topic. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]357 body: object, The request body. (required)
358 The object takes the form of:
359
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]360{ # Request for the Publish method.
361 "messages": [ # The messages to publish.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]362 { # A message data and its attributes. The message payload must not be empty;
363 # it must contain either a non-empty data field, or at least one attribute.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]364 "attributes": { # Optional attributes for this message.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]365 "a_key": "A String",
366 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]367 "data": "A String", # The message payload. For JSON requests, the value of this field must be
368 # [base64-encoded](https://tools.ietf.org/html/rfc4648).
369 "publishTime": "A String", # The time at which the message was published, populated by the server when
370 # it receives the `Publish` call. It must not be populated by the
371 # publisher in a `Publish` call.
372 "messageId": "A String", # ID of this message, assigned by the server when the message is published.
373 # Guaranteed to be unique within the topic. This value may be read by a
374 # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
375 # delivery. It must not be populated by the publisher in a `Publish` call.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]376 },
377 ],
378 }
379
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]380 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]381 Allowed values
382 1 - v1 error format
383 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]384
385Returns:
386 An object of the form:
387
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]388 { # Response for the `Publish` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]389 "messageIds": [ # The server-assigned ID of each published message, in the same order as
390 # the messages in the request. IDs are guaranteed to be unique within
391 # the topic.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]392 "A String",
393 ],
394 }</pre>
395</div>
396
397<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]398 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
399 <pre>Sets the access control policy on the specified resource. Replaces any
400existing policy.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]401
402Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]403 resource: string, REQUIRED: The resource for which the policy is being specified.
404`resource` is usually specified as a path. For example, a Project
405resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]406 body: object, The request body. (required)
407 The object takes the form of:
408
409{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]410 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
411 # the policy is limited to a few 10s of KB. An empty policy is a
412 # valid policy but certain Cloud Platform services (such as Projects)
413 # might reject them.
414 # specify access control policies for Cloud Platform resources.
415 #
416 #
417 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
418 # `members` to a `role`, where the members can be user accounts, Google groups,
419 # Google domains, and service accounts. A `role` is a named list of permissions
420 # defined by IAM.
421 #
422 # **Example**
423 #
424 # {
425 # "bindings": [
426 # {
427 # "role": "roles/owner",
428 # "members": [
429 # "user:mike@example.com",
430 # "group:admins@example.com",
431 # "domain:google.com",
432 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
433 # ]
434 # },
435 # {
436 # "role": "roles/viewer",
437 # "members": ["user:sean@example.com"]
438 # }
439 # ]
440 # }
441 #
442 # For a description of IAM and its features, see the
443 # [IAM developer's guide](https://cloud.google.com/iam).
444 "bindings": [ # Associates a list of `members` to a `role`.
445 # Multiple `bindings` must not be specified for the same `role`.
446 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]447 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]448 "role": "A String", # Role that is assigned to `members`.
449 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
450 # Required
451 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
452 # `members` can have the following values:
453 #
454 # * `allUsers`: A special identifier that represents anyone who is
455 # on the internet; with or without a Google account.
456 #
457 # * `allAuthenticatedUsers`: A special identifier that represents anyone
458 # who is authenticated with a Google account or a service account.
459 #
460 # * `user:{emailid}`: An email address that represents a specific Google
461 # account. For example, `alice@gmail.com` or `joe@example.com`.
462 #
463 #
464 # * `serviceAccount:{emailid}`: An email address that represents a service
465 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
466 #
467 # * `group:{emailid}`: An email address that represents a Google group.
468 # For example, `admins@example.com`.
469 #
470 # * `domain:{domain}`: A Google Apps domain name that represents all the
471 # users of that domain. For example, `google.com` or `example.com`.
472 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]473 "A String",
474 ],
475 },
476 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]477 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
478 # prevent simultaneous updates of a policy from overwriting each other.
479 # It is strongly suggested that systems make use of the `etag` in the
480 # read-modify-write cycle to perform policy updates in order to avoid race
481 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
482 # systems are expected to put that etag in the request to `setIamPolicy` to
483 # ensure that their change will be applied to the same version of the policy.
484 #
485 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
486 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]487 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]488 },
489 }
490
491 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]492 Allowed values
493 1 - v1 error format
494 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]495
496Returns:
497 An object of the form:
498
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]499 { # Defines an Identity and Access Management (IAM) policy. It is used to
500 # specify access control policies for Cloud Platform resources.
501 #
502 #
503 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
504 # `members` to a `role`, where the members can be user accounts, Google groups,
505 # Google domains, and service accounts. A `role` is a named list of permissions
506 # defined by IAM.
507 #
508 # **Example**
509 #
510 # {
511 # "bindings": [
512 # {
513 # "role": "roles/owner",
514 # "members": [
515 # "user:mike@example.com",
516 # "group:admins@example.com",
517 # "domain:google.com",
518 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
519 # ]
520 # },
521 # {
522 # "role": "roles/viewer",
523 # "members": ["user:sean@example.com"]
524 # }
525 # ]
526 # }
527 #
528 # For a description of IAM and its features, see the
529 # [IAM developer's guide](https://cloud.google.com/iam).
530 "bindings": [ # Associates a list of `members` to a `role`.
531 # Multiple `bindings` must not be specified for the same `role`.
532 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]533 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]534 "role": "A String", # Role that is assigned to `members`.
535 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
536 # Required
537 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
538 # `members` can have the following values:
539 #
540 # * `allUsers`: A special identifier that represents anyone who is
541 # on the internet; with or without a Google account.
542 #
543 # * `allAuthenticatedUsers`: A special identifier that represents anyone
544 # who is authenticated with a Google account or a service account.
545 #
546 # * `user:{emailid}`: An email address that represents a specific Google
547 # account. For example, `alice@gmail.com` or `joe@example.com`.
548 #
549 #
550 # * `serviceAccount:{emailid}`: An email address that represents a service
551 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
552 #
553 # * `group:{emailid}`: An email address that represents a Google group.
554 # For example, `admins@example.com`.
555 #
556 # * `domain:{domain}`: A Google Apps domain name that represents all the
557 # users of that domain. For example, `google.com` or `example.com`.
558 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]559 "A String",
560 ],
561 },
562 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]563 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
564 # prevent simultaneous updates of a policy from overwriting each other.
565 # It is strongly suggested that systems make use of the `etag` in the
566 # read-modify-write cycle to perform policy updates in order to avoid race
567 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
568 # systems are expected to put that etag in the request to `setIamPolicy` to
569 # ensure that their change will be applied to the same version of the policy.
570 #
571 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
572 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]573 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]574 }</pre>
575</div>
576
577<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]578 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]579 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]580If the resource does not exist, this will return an empty set of
581permissions, not a NOT_FOUND error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]582
583Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]584 resource: string, REQUIRED: The resource for which the policy detail is being requested.
585`resource` is usually specified as a path. For example, a Project
586resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]587 body: object, The request body. (required)
588 The object takes the form of:
589
590{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]591 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
592 # wildcards (such as '*' or 'storage.*') are not allowed. For more
593 # information see
594 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]595 "A String",
596 ],
597 }
598
599 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]600 Allowed values
601 1 - v1 error format
602 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]603
604Returns:
605 An object of the form:
606
607 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]608 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
609 # allowed.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]610 "A String",
611 ],
612 }</pre>
613</div>
614
615</body></html>