Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / pubsub_v1beta2.projects.subscriptions.html
blob: 1b34bc400e3e4d430da19f6062876f4b670623da [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.subscriptions.html">subscriptions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]78 <code><a href="#acknowledge">acknowledge(subscription, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]79<p class="firstline">Acknowledges the messages associated with the `ack_ids` in the</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]80<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]81 <code><a href="#create">create(name=None, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a subscription to a given topic.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]83<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]84 <code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Deletes an existing subscription. All pending messages in the subscription</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]87 <code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]88<p class="firstline">Gets the configuration details of a subscription.</p>
89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]90 <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets the access control policy for a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<p class="toc_element">
93 <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]94<p class="firstline">Lists matching subscriptions.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]99 <code><a href="#modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]100<p class="firstline">Modifies the ack deadline for a specific message. This method is useful</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]101<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102 <code><a href="#modifyPushConfig">modifyPushConfig(subscription, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]103<p class="firstline">Modifies the `PushConfig` for a specified subscription.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]104<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]105 <code><a href="#pull">pull(subscription, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]106<p class="firstline">Pulls messages from the server. Returns an empty list if there are no</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
109<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]110<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]111 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]113<h3>Method Details</h3>
114<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115 <code class="details" id="acknowledge">acknowledge(subscription, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]116 <pre>Acknowledges the messages associated with the `ack_ids` in the
117`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
118from the subscription.
119
120Acknowledging a message whose ack deadline has expired may succeed,
121but such a message may be redelivered later. Acknowledging a message more
122than once will not result in an error.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123
124Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]125 subscription: string, The subscription whose message is being acknowledged. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]126 body: object, The request body. (required)
127 The object takes the form of:
128
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]129{ # Request for the Acknowledge method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]130 "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned
131 # by the Pub/Sub system in the `Pull` response. Must not be empty.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]132 "A String",
133 ],
134 }
135
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]136 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140
141Returns:
142 An object of the form:
143
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]144 { # A generic empty message that you can re-use to avoid defining duplicated
145 # empty messages in your APIs. A typical example is to use it as the request
146 # or the response type of an API method. For instance:
147 #
148 # service Foo {
149 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
150 # }
151 #
152 # The JSON representation for `Empty` is empty JSON object `{}`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]157 <code class="details" id="create">create(name=None, body, x__xgafv=None)</code>
158 <pre>Creates a subscription to a given topic.
159If the subscription already exists, returns `ALREADY_EXISTS`.
160If the corresponding topic doesn't exist, returns `NOT_FOUND`.
161
162If the name is not provided in the request, the server will assign a random
163name for this subscription on the same project as the topic. Note that
164for REST API requests, you must specify a name.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]165
166Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]167 name: string, The name of the subscription. It must have the format
168`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
169start with a letter, and contain only letters (`[A-Za-z]`), numbers
170(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
171plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
172in length, and it must not start with `"goog"`. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 body: object, The request body. (required)
174 The object takes the form of:
175
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]176{ # A subscription resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]177 "topic": "A String", # The name of the topic from which this subscription is receiving messages.
178 # The value of this field will be `_deleted-topic_` if the topic has been
179 # deleted.
180 "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
181 # before the subscriber should acknowledge the message. After message
182 # delivery but before the ack deadline expires and before the message is
183 # acknowledged, it is an outstanding message and will not be delivered
184 # again during that time (on a best-effort basis).
185 #
186 # For pull subscriptions, this value is used as the initial value for the ack
187 # deadline. To override this value for a given message, call
188 # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
189 # The maximum custom deadline you can specify is 600 seconds (10 minutes).
190 #
191 # For push delivery, this value is also used to set the request timeout for
192 # the call to the push endpoint.
193 #
194 # If the subscriber never acknowledges the message, the Pub/Sub
195 # system will eventually redeliver the message.
196 #
197 # If this parameter is 0, a default value of 10 seconds is used.
198 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
199 # used to configure it. An empty `pushConfig` signifies that the subscriber
200 # will pull and ack messages using API methods.
201 "attributes": { # Endpoint configuration attributes.
202 #
203 # Every endpoint has a set of API supported attributes that can be used to
204 # control different aspects of the message delivery.
205 #
206 # The currently supported attribute is `x-goog-version`, which you can
207 # use to change the format of the push message. This attribute
208 # indicates the version of the data expected by the endpoint. This
209 # controls the shape of the envelope (i.e. its fields and metadata).
210 # The endpoint version is based on the version of the Pub/Sub
211 # API.
212 #
213 # If not present during the `CreateSubscription` call, it will default to
214 # the version of the API used to make such call. If not present during a
215 # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
216 # calls will always return a valid version, even if the subscription was
217 # created without this attribute.
218 #
219 # The possible values for this attribute are:
220 #
221 # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
222 # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]223 "a_key": "A String",
224 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]225 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
226 # For example, a Webhook endpoint might use "https://example.com/push".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]227 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]228 "name": "A String", # The name of the subscription. It must have the format
229 # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
230 # start with a letter, and contain only letters (`[A-Za-z]`), numbers
231 # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
232 # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
233 # in length, and it must not start with `"goog"`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]234}
235
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]236 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]240
241Returns:
242 An object of the form:
243
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]244 { # A subscription resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]245 "topic": "A String", # The name of the topic from which this subscription is receiving messages.
246 # The value of this field will be `_deleted-topic_` if the topic has been
247 # deleted.
248 "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
249 # before the subscriber should acknowledge the message. After message
250 # delivery but before the ack deadline expires and before the message is
251 # acknowledged, it is an outstanding message and will not be delivered
252 # again during that time (on a best-effort basis).
253 #
254 # For pull subscriptions, this value is used as the initial value for the ack
255 # deadline. To override this value for a given message, call
256 # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
257 # The maximum custom deadline you can specify is 600 seconds (10 minutes).
258 #
259 # For push delivery, this value is also used to set the request timeout for
260 # the call to the push endpoint.
261 #
262 # If the subscriber never acknowledges the message, the Pub/Sub
263 # system will eventually redeliver the message.
264 #
265 # If this parameter is 0, a default value of 10 seconds is used.
266 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
267 # used to configure it. An empty `pushConfig` signifies that the subscriber
268 # will pull and ack messages using API methods.
269 "attributes": { # Endpoint configuration attributes.
270 #
271 # Every endpoint has a set of API supported attributes that can be used to
272 # control different aspects of the message delivery.
273 #
274 # The currently supported attribute is `x-goog-version`, which you can
275 # use to change the format of the push message. This attribute
276 # indicates the version of the data expected by the endpoint. This
277 # controls the shape of the envelope (i.e. its fields and metadata).
278 # The endpoint version is based on the version of the Pub/Sub
279 # API.
280 #
281 # If not present during the `CreateSubscription` call, it will default to
282 # the version of the API used to make such call. If not present during a
283 # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
284 # calls will always return a valid version, even if the subscription was
285 # created without this attribute.
286 #
287 # The possible values for this attribute are:
288 #
289 # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
290 # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]291 "a_key": "A String",
292 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]293 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
294 # For example, a Webhook endpoint might use "https://example.com/push".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]295 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]296 "name": "A String", # The name of the subscription. It must have the format
297 # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
298 # start with a letter, and contain only letters (`[A-Za-z]`), numbers
299 # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
300 # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
301 # in length, and it must not start with `"goog"`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]302 }</pre>
303</div>
304
305<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]306 <code class="details" id="delete">delete(subscription, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]307 <pre>Deletes an existing subscription. All pending messages in the subscription
308are immediately dropped. Calls to `Pull` after deletion will return
309`NOT_FOUND`. After a subscription is deleted, a new one may be created with
310the same name, but the new one has no association with the old
311subscription, or its topic unless the same topic is specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]312
313Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]314 subscription: string, The subscription to delete. (required)
315 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]316 Allowed values
317 1 - v1 error format
318 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]319
320Returns:
321 An object of the form:
322
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]323 { # A generic empty message that you can re-use to avoid defining duplicated
324 # empty messages in your APIs. A typical example is to use it as the request
325 # or the response type of an API method. For instance:
326 #
327 # service Foo {
328 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
329 # }
330 #
331 # The JSON representation for `Empty` is empty JSON object `{}`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]332 }</pre>
333</div>
334
335<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]336 <code class="details" id="get">get(subscription, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]337 <pre>Gets the configuration details of a subscription.
338
339Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]340 subscription: string, The name of the subscription to get. (required)
341 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]342 Allowed values
343 1 - v1 error format
344 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]345
346Returns:
347 An object of the form:
348
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]349 { # A subscription resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]350 "topic": "A String", # The name of the topic from which this subscription is receiving messages.
351 # The value of this field will be `_deleted-topic_` if the topic has been
352 # deleted.
353 "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
354 # before the subscriber should acknowledge the message. After message
355 # delivery but before the ack deadline expires and before the message is
356 # acknowledged, it is an outstanding message and will not be delivered
357 # again during that time (on a best-effort basis).
358 #
359 # For pull subscriptions, this value is used as the initial value for the ack
360 # deadline. To override this value for a given message, call
361 # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
362 # The maximum custom deadline you can specify is 600 seconds (10 minutes).
363 #
364 # For push delivery, this value is also used to set the request timeout for
365 # the call to the push endpoint.
366 #
367 # If the subscriber never acknowledges the message, the Pub/Sub
368 # system will eventually redeliver the message.
369 #
370 # If this parameter is 0, a default value of 10 seconds is used.
371 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
372 # used to configure it. An empty `pushConfig` signifies that the subscriber
373 # will pull and ack messages using API methods.
374 "attributes": { # Endpoint configuration attributes.
375 #
376 # Every endpoint has a set of API supported attributes that can be used to
377 # control different aspects of the message delivery.
378 #
379 # The currently supported attribute is `x-goog-version`, which you can
380 # use to change the format of the push message. This attribute
381 # indicates the version of the data expected by the endpoint. This
382 # controls the shape of the envelope (i.e. its fields and metadata).
383 # The endpoint version is based on the version of the Pub/Sub
384 # API.
385 #
386 # If not present during the `CreateSubscription` call, it will default to
387 # the version of the API used to make such call. If not present during a
388 # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
389 # calls will always return a valid version, even if the subscription was
390 # created without this attribute.
391 #
392 # The possible values for this attribute are:
393 #
394 # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
395 # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]396 "a_key": "A String",
397 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]398 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
399 # For example, a Webhook endpoint might use "https://example.com/push".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]400 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]401 "name": "A String", # The name of the subscription. It must have the format
402 # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
403 # start with a letter, and contain only letters (`[A-Za-z]`), numbers
404 # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
405 # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
406 # in length, and it must not start with `"goog"`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]407 }</pre>
408</div>
409
410<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]411 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
412 <pre>Gets the access control policy for a resource.
413Returns an empty policy if the resource exists and does not have a policy
414set.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]415
416Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]417 resource: string, REQUIRED: The resource for which the policy is being requested.
418`resource` is usually specified as a path. For example, a Project
419resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]420 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]421 Allowed values
422 1 - v1 error format
423 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]424
425Returns:
426 An object of the form:
427
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]428 { # Defines an Identity and Access Management (IAM) policy. It is used to
429 # specify access control policies for Cloud Platform resources.
430 #
431 #
432 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
433 # `members` to a `role`, where the members can be user accounts, Google groups,
434 # Google domains, and service accounts. A `role` is a named list of permissions
435 # defined by IAM.
436 #
437 # **Example**
438 #
439 # {
440 # "bindings": [
441 # {
442 # "role": "roles/owner",
443 # "members": [
444 # "user:mike@example.com",
445 # "group:admins@example.com",
446 # "domain:google.com",
447 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
448 # ]
449 # },
450 # {
451 # "role": "roles/viewer",
452 # "members": ["user:sean@example.com"]
453 # }
454 # ]
455 # }
456 #
457 # For a description of IAM and its features, see the
458 # [IAM developer's guide](https://cloud.google.com/iam).
459 "bindings": [ # Associates a list of `members` to a `role`.
460 # Multiple `bindings` must not be specified for the same `role`.
461 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]462 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]463 "role": "A String", # Role that is assigned to `members`.
464 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
465 # Required
466 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
467 # `members` can have the following values:
468 #
469 # * `allUsers`: A special identifier that represents anyone who is
470 # on the internet; with or without a Google account.
471 #
472 # * `allAuthenticatedUsers`: A special identifier that represents anyone
473 # who is authenticated with a Google account or a service account.
474 #
475 # * `user:{emailid}`: An email address that represents a specific Google
476 # account. For example, `alice@gmail.com` or `joe@example.com`.
477 #
478 #
479 # * `serviceAccount:{emailid}`: An email address that represents a service
480 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
481 #
482 # * `group:{emailid}`: An email address that represents a Google group.
483 # For example, `admins@example.com`.
484 #
485 # * `domain:{domain}`: A Google Apps domain name that represents all the
486 # users of that domain. For example, `google.com` or `example.com`.
487 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]488 "A String",
489 ],
490 },
491 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]492 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
493 # prevent simultaneous updates of a policy from overwriting each other.
494 # It is strongly suggested that systems make use of the `etag` in the
495 # read-modify-write cycle to perform policy updates in order to avoid race
496 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
497 # systems are expected to put that etag in the request to `setIamPolicy` to
498 # ensure that their change will be applied to the same version of the policy.
499 #
500 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
501 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]502 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]503 }</pre>
504</div>
505
506<div class="method">
507 <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
508 <pre>Lists matching subscriptions.
509
510Args:
511 project: string, The name of the cloud project that subscriptions belong to. (required)
512 pageSize: integer, Maximum number of subscriptions to return.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]513 pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that
514this is a continuation of a prior `ListSubscriptions` call, and that the
515system should return the next page of data.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]516 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]517 Allowed values
518 1 - v1 error format
519 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]520
521Returns:
522 An object of the form:
523
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]524 { # Response for the `ListSubscriptions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]525 "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match
526 # the request; this value should be passed in a new
527 # `ListSubscriptionsRequest` to get more subscriptions.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]528 "subscriptions": [ # The subscriptions that match the request.
529 { # A subscription resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]530 "topic": "A String", # The name of the topic from which this subscription is receiving messages.
531 # The value of this field will be `_deleted-topic_` if the topic has been
532 # deleted.
533 "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
534 # before the subscriber should acknowledge the message. After message
535 # delivery but before the ack deadline expires and before the message is
536 # acknowledged, it is an outstanding message and will not be delivered
537 # again during that time (on a best-effort basis).
538 #
539 # For pull subscriptions, this value is used as the initial value for the ack
540 # deadline. To override this value for a given message, call
541 # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
542 # The maximum custom deadline you can specify is 600 seconds (10 minutes).
543 #
544 # For push delivery, this value is also used to set the request timeout for
545 # the call to the push endpoint.
546 #
547 # If the subscriber never acknowledges the message, the Pub/Sub
548 # system will eventually redeliver the message.
549 #
550 # If this parameter is 0, a default value of 10 seconds is used.
551 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
552 # used to configure it. An empty `pushConfig` signifies that the subscriber
553 # will pull and ack messages using API methods.
554 "attributes": { # Endpoint configuration attributes.
555 #
556 # Every endpoint has a set of API supported attributes that can be used to
557 # control different aspects of the message delivery.
558 #
559 # The currently supported attribute is `x-goog-version`, which you can
560 # use to change the format of the push message. This attribute
561 # indicates the version of the data expected by the endpoint. This
562 # controls the shape of the envelope (i.e. its fields and metadata).
563 # The endpoint version is based on the version of the Pub/Sub
564 # API.
565 #
566 # If not present during the `CreateSubscription` call, it will default to
567 # the version of the API used to make such call. If not present during a
568 # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
569 # calls will always return a valid version, even if the subscription was
570 # created without this attribute.
571 #
572 # The possible values for this attribute are:
573 #
574 # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
575 # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]576 "a_key": "A String",
577 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]578 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
579 # For example, a Webhook endpoint might use "https://example.com/push".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]580 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]581 "name": "A String", # The name of the subscription. It must have the format
582 # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
583 # start with a letter, and contain only letters (`[A-Za-z]`), numbers
584 # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
585 # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
586 # in length, and it must not start with `"goog"`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]587 },
588 ],
589 }</pre>
590</div>
591
592<div class="method">
593 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
594 <pre>Retrieves the next page of results.
595
596Args:
597 previous_request: The request for the previous page. (required)
598 previous_response: The response from the request for the previous page. (required)
599
600Returns:
601 A request object that you can call 'execute()' on to request the next
602 page. Returns None if there are no more items in the collection.
603 </pre>
604</div>
605
606<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]607 <code class="details" id="modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]608 <pre>Modifies the ack deadline for a specific message. This method is useful
609to indicate that more time is needed to process a message by the
610subscriber, or to make the message available for redelivery if the
611processing was interrupted. Note that this does not modify the
612subscription-level `ackDeadlineSeconds` used for subsequent messages.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]613
614Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]615 subscription: string, The name of the subscription. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]616 body: object, The request body. (required)
617 The object takes the form of:
618
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]619{ # Request for the ModifyAckDeadline method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]620 "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to
621 # the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new
622 # ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
623 # was made. Specifying zero may immediately make the message available for
624 # another pull request.
625 "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
626 # both.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]627 "ackIds": [ # List of acknowledgment IDs.
628 "A String",
629 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]630 }
631
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]632 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]633 Allowed values
634 1 - v1 error format
635 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]636
637Returns:
638 An object of the form:
639
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]640 { # A generic empty message that you can re-use to avoid defining duplicated
641 # empty messages in your APIs. A typical example is to use it as the request
642 # or the response type of an API method. For instance:
643 #
644 # service Foo {
645 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
646 # }
647 #
648 # The JSON representation for `Empty` is empty JSON object `{}`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]649 }</pre>
650</div>
651
652<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]653 <code class="details" id="modifyPushConfig">modifyPushConfig(subscription, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]654 <pre>Modifies the `PushConfig` for a specified subscription.
655
656This may be used to change a push subscription to a pull one (signified by
657an empty `PushConfig`) or vice versa, or change the endpoint URL and other
658attributes of a push subscription. Messages will accumulate for delivery
659continuously through the call regardless of changes to the `PushConfig`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]660
661Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]662 subscription: string, The name of the subscription. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]663 body: object, The request body. (required)
664 The object takes the form of:
665
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]666{ # Request for the ModifyPushConfig method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]667 "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries.
668 #
669 # An empty `pushConfig` indicates that the Pub/Sub system should
670 # stop pushing messages from the given subscription and allow
671 # messages to be pulled and acknowledged - effectively pausing
672 # the subscription if `Pull` is not called.
673 "attributes": { # Endpoint configuration attributes.
674 #
675 # Every endpoint has a set of API supported attributes that can be used to
676 # control different aspects of the message delivery.
677 #
678 # The currently supported attribute is `x-goog-version`, which you can
679 # use to change the format of the push message. This attribute
680 # indicates the version of the data expected by the endpoint. This
681 # controls the shape of the envelope (i.e. its fields and metadata).
682 # The endpoint version is based on the version of the Pub/Sub
683 # API.
684 #
685 # If not present during the `CreateSubscription` call, it will default to
686 # the version of the API used to make such call. If not present during a
687 # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
688 # calls will always return a valid version, even if the subscription was
689 # created without this attribute.
690 #
691 # The possible values for this attribute are:
692 #
693 # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
694 # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]695 "a_key": "A String",
696 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]697 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
698 # For example, a Webhook endpoint might use "https://example.com/push".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]699 },
700 }
701
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]702 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]703 Allowed values
704 1 - v1 error format
705 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]706
707Returns:
708 An object of the form:
709
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]710 { # A generic empty message that you can re-use to avoid defining duplicated
711 # empty messages in your APIs. A typical example is to use it as the request
712 # or the response type of an API method. For instance:
713 #
714 # service Foo {
715 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
716 # }
717 #
718 # The JSON representation for `Empty` is empty JSON object `{}`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]719 }</pre>
720</div>
721
722<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]723 <code class="details" id="pull">pull(subscription, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]724 <pre>Pulls messages from the server. Returns an empty list if there are no
725messages available in the backlog. The server may return `UNAVAILABLE` if
726there are too many concurrent pull requests pending for the given
727subscription.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]728
729Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]730 subscription: string, The subscription from which messages should be pulled. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]731 body: object, The request body. (required)
732 The object takes the form of:
733
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]734{ # Request for the `Pull` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]735 "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if
736 # it is not able to return a message in the `Pull` response. Otherwise the
737 # system is allowed to wait until at least one message is available rather
738 # than returning no messages. The client may cancel the request if it does
739 # not wish to wait any longer for the response.
740 "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub
741 # system may return fewer than the number specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]742 }
743
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]744 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]745 Allowed values
746 1 - v1 error format
747 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]748
749Returns:
750 An object of the form:
751
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]752 { # Response for the `Pull` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]753 "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if
754 # there are no more available in the backlog. The Pub/Sub system may return
755 # fewer than the `maxMessages` requested even if there are more messages
756 # available in the backlog.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]757 { # A message and its corresponding acknowledgment ID.
758 "ackId": "A String", # This ID can be used to acknowledge the received message.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]759 "message": { # A message data and its attributes. The message payload must not be empty; # The message.
760 # it must contain either a non-empty data field, or at least one attribute.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]761 "attributes": { # Optional attributes for this message.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]762 "a_key": "A String",
763 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]764 "data": "A String", # The message payload. For JSON requests, the value of this field must be
765 # [base64-encoded](https://tools.ietf.org/html/rfc4648).
766 "publishTime": "A String", # The time at which the message was published, populated by the server when
767 # it receives the `Publish` call. It must not be populated by the
768 # publisher in a `Publish` call.
769 "messageId": "A String", # ID of this message, assigned by the server when the message is published.
770 # Guaranteed to be unique within the topic. This value may be read by a
771 # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
772 # delivery. It must not be populated by the publisher in a `Publish` call.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]773 },
774 },
775 ],
776 }</pre>
777</div>
778
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]779<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]780 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
781 <pre>Sets the access control policy on the specified resource. Replaces any
782existing policy.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]783
784Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]785 resource: string, REQUIRED: The resource for which the policy is being specified.
786`resource` is usually specified as a path. For example, a Project
787resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]788 body: object, The request body. (required)
789 The object takes the form of:
790
791{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]792 "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
793 # the policy is limited to a few 10s of KB. An empty policy is a
794 # valid policy but certain Cloud Platform services (such as Projects)
795 # might reject them.
796 # specify access control policies for Cloud Platform resources.
797 #
798 #
799 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
800 # `members` to a `role`, where the members can be user accounts, Google groups,
801 # Google domains, and service accounts. A `role` is a named list of permissions
802 # defined by IAM.
803 #
804 # **Example**
805 #
806 # {
807 # "bindings": [
808 # {
809 # "role": "roles/owner",
810 # "members": [
811 # "user:mike@example.com",
812 # "group:admins@example.com",
813 # "domain:google.com",
814 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
815 # ]
816 # },
817 # {
818 # "role": "roles/viewer",
819 # "members": ["user:sean@example.com"]
820 # }
821 # ]
822 # }
823 #
824 # For a description of IAM and its features, see the
825 # [IAM developer's guide](https://cloud.google.com/iam).
826 "bindings": [ # Associates a list of `members` to a `role`.
827 # Multiple `bindings` must not be specified for the same `role`.
828 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]829 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]830 "role": "A String", # Role that is assigned to `members`.
831 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
832 # Required
833 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
834 # `members` can have the following values:
835 #
836 # * `allUsers`: A special identifier that represents anyone who is
837 # on the internet; with or without a Google account.
838 #
839 # * `allAuthenticatedUsers`: A special identifier that represents anyone
840 # who is authenticated with a Google account or a service account.
841 #
842 # * `user:{emailid}`: An email address that represents a specific Google
843 # account. For example, `alice@gmail.com` or `joe@example.com`.
844 #
845 #
846 # * `serviceAccount:{emailid}`: An email address that represents a service
847 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
848 #
849 # * `group:{emailid}`: An email address that represents a Google group.
850 # For example, `admins@example.com`.
851 #
852 # * `domain:{domain}`: A Google Apps domain name that represents all the
853 # users of that domain. For example, `google.com` or `example.com`.
854 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]855 "A String",
856 ],
857 },
858 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]859 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
860 # prevent simultaneous updates of a policy from overwriting each other.
861 # It is strongly suggested that systems make use of the `etag` in the
862 # read-modify-write cycle to perform policy updates in order to avoid race
863 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
864 # systems are expected to put that etag in the request to `setIamPolicy` to
865 # ensure that their change will be applied to the same version of the policy.
866 #
867 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
868 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]869 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]870 },
871 }
872
873 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]874 Allowed values
875 1 - v1 error format
876 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]877
878Returns:
879 An object of the form:
880
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]881 { # Defines an Identity and Access Management (IAM) policy. It is used to
882 # specify access control policies for Cloud Platform resources.
883 #
884 #
885 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
886 # `members` to a `role`, where the members can be user accounts, Google groups,
887 # Google domains, and service accounts. A `role` is a named list of permissions
888 # defined by IAM.
889 #
890 # **Example**
891 #
892 # {
893 # "bindings": [
894 # {
895 # "role": "roles/owner",
896 # "members": [
897 # "user:mike@example.com",
898 # "group:admins@example.com",
899 # "domain:google.com",
900 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
901 # ]
902 # },
903 # {
904 # "role": "roles/viewer",
905 # "members": ["user:sean@example.com"]
906 # }
907 # ]
908 # }
909 #
910 # For a description of IAM and its features, see the
911 # [IAM developer's guide](https://cloud.google.com/iam).
912 "bindings": [ # Associates a list of `members` to a `role`.
913 # Multiple `bindings` must not be specified for the same `role`.
914 # `bindings` with no members will result in an error.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]915 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]916 "role": "A String", # Role that is assigned to `members`.
917 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
918 # Required
919 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
920 # `members` can have the following values:
921 #
922 # * `allUsers`: A special identifier that represents anyone who is
923 # on the internet; with or without a Google account.
924 #
925 # * `allAuthenticatedUsers`: A special identifier that represents anyone
926 # who is authenticated with a Google account or a service account.
927 #
928 # * `user:{emailid}`: An email address that represents a specific Google
929 # account. For example, `alice@gmail.com` or `joe@example.com`.
930 #
931 #
932 # * `serviceAccount:{emailid}`: An email address that represents a service
933 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
934 #
935 # * `group:{emailid}`: An email address that represents a Google group.
936 # For example, `admins@example.com`.
937 #
938 # * `domain:{domain}`: A Google Apps domain name that represents all the
939 # users of that domain. For example, `google.com` or `example.com`.
940 #
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]941 "A String",
942 ],
943 },
944 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]945 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
946 # prevent simultaneous updates of a policy from overwriting each other.
947 # It is strongly suggested that systems make use of the `etag` in the
948 # read-modify-write cycle to perform policy updates in order to avoid race
949 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
950 # systems are expected to put that etag in the request to `setIamPolicy` to
951 # ensure that their change will be applied to the same version of the policy.
952 #
953 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
954 # policy is overwritten blindly.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]955 "version": 42, # Version of the `Policy`. The default version is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]956 }</pre>
957</div>
958
959<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]960 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]961 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]962If the resource does not exist, this will return an empty set of
963permissions, not a NOT_FOUND error.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]964
965Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]966 resource: string, REQUIRED: The resource for which the policy detail is being requested.
967`resource` is usually specified as a path. For example, a Project
968resource is specified as `projects/{project}`. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]969 body: object, The request body. (required)
970 The object takes the form of:
971
972{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]973 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
974 # wildcards (such as '*' or 'storage.*') are not allowed. For more
975 # information see
976 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]977 "A String",
978 ],
979 }
980
981 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]982 Allowed values
983 1 - v1 error format
984 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]985
986Returns:
987 An object of the form:
988
989 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]990 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
991 # allowed.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]992 "A String",
993 ],
994 }</pre>
995</div>
996
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]997</body></html>