PluginProbe
Authorizer / 2.6.10
Authorizer v2.6.10
3.15.3 3.15.2 3.15.1 3.15.0 3.14.3 3.14.4 3.14.2 3.14.1 2.8.1 2.8.2 2.8.3 2.8.4 2.8.5 2.8.6 2.8.7 2.8.8 2.9.0 2.9.1 2.9.10 2.9.11 2.9.12 2.9.13 2.9.2 2.9.3 2.9.6 All 126 releases
authorizer / vendor / google-api-php-client / src / Google / Service / Pubsub.php

Pubsub.php in Authorizer 2.6.10, at vendor/google-api-php-client/src/Google/Service/Pubsub.php

1,256 lines 38.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /*
3 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 * use this file except in compliance with the License. You may obtain a copy of
5 * the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 * License for the specific language governing permissions and limitations under
13 * the License.
14 */
15
16 /**
17 * Service definition for Pubsub (v1).
18 *
19 * <p>
20 * Provides reliable, many-to-many, asynchronous messaging between applications.</p>
21 *
22 * <p>
23 * For more information about this service, see the API
24 * <a href="https://cloud.google.com/pubsub/docs" target="_blank">Documentation</a>
25 * </p>
26 *
27 * @author Google, Inc.
28 */
29 class Google_Service_Pubsub extends Google_Service
30 {
31 /** View and manage your data across Google Cloud Platform services. */
32 const CLOUD_PLATFORM =
33 "https://www.googleapis.com/auth/cloud-platform";
34 /** View and manage Pub/Sub topics and subscriptions. */
35 const PUBSUB =
36 "https://www.googleapis.com/auth/pubsub";
37
38 public $projects_subscriptions;
39 public $projects_topics;
40 public $projects_topics_subscriptions;
41
42
43 /**
44 * Constructs the internal representation of the Pubsub service.
45 *
46 * @param Google_Client $client
47 */
48 public function __construct(Google_Client $client)
49 {
50 parent::__construct($client);
51 $this->rootUrl = 'https://pubsub.googleapis.com/';
52 $this->servicePath = '';
53 $this->version = 'v1';
54 $this->serviceName = 'pubsub';
55
56 $this->projects_subscriptions = new Google_Service_Pubsub_ProjectsSubscriptions_Resource(
57 $this,
58 $this->serviceName,
59 'subscriptions',
60 array(
61 'methods' => array(
62 'acknowledge' => array(
63 'path' => 'v1/{+subscription}:acknowledge',
64 'httpMethod' => 'POST',
65 'parameters' => array(
66 'subscription' => array(
67 'location' => 'path',
68 'type' => 'string',
69 'required' => true,
70 ),
71 ),
72 ),'create' => array(
73 'path' => 'v1/{+name}',
74 'httpMethod' => 'PUT',
75 'parameters' => array(
76 'name' => array(
77 'location' => 'path',
78 'type' => 'string',
79 'required' => true,
80 ),
81 ),
82 ),'delete' => array(
83 'path' => 'v1/{+subscription}',
84 'httpMethod' => 'DELETE',
85 'parameters' => array(
86 'subscription' => array(
87 'location' => 'path',
88 'type' => 'string',
89 'required' => true,
90 ),
91 ),
92 ),'get' => array(
93 'path' => 'v1/{+subscription}',
94 'httpMethod' => 'GET',
95 'parameters' => array(
96 'subscription' => array(
97 'location' => 'path',
98 'type' => 'string',
99 'required' => true,
100 ),
101 ),
102 ),'getIamPolicy' => array(
103 'path' => 'v1/{+resource}:getIamPolicy',
104 'httpMethod' => 'GET',
105 'parameters' => array(
106 'resource' => array(
107 'location' => 'path',
108 'type' => 'string',
109 'required' => true,
110 ),
111 ),
112 ),'list' => array(
113 'path' => 'v1/{+project}/subscriptions',
114 'httpMethod' => 'GET',
115 'parameters' => array(
116 'project' => array(
117 'location' => 'path',
118 'type' => 'string',
119 'required' => true,
120 ),
121 'pageSize' => array(
122 'location' => 'query',
123 'type' => 'integer',
124 ),
125 'pageToken' => array(
126 'location' => 'query',
127 'type' => 'string',
128 ),
129 ),
130 ),'modifyAckDeadline' => array(
131 'path' => 'v1/{+subscription}:modifyAckDeadline',
132 'httpMethod' => 'POST',
133 'parameters' => array(
134 'subscription' => array(
135 'location' => 'path',
136 'type' => 'string',
137 'required' => true,
138 ),
139 ),
140 ),'modifyPushConfig' => array(
141 'path' => 'v1/{+subscription}:modifyPushConfig',
142 'httpMethod' => 'POST',
143 'parameters' => array(
144 'subscription' => array(
145 'location' => 'path',
146 'type' => 'string',
147 'required' => true,
148 ),
149 ),
150 ),'pull' => array(
151 'path' => 'v1/{+subscription}:pull',
152 'httpMethod' => 'POST',
153 'parameters' => array(
154 'subscription' => array(
155 'location' => 'path',
156 'type' => 'string',
157 'required' => true,
158 ),
159 ),
160 ),'setIamPolicy' => array(
161 'path' => 'v1/{+resource}:setIamPolicy',
162 'httpMethod' => 'POST',
163 'parameters' => array(
164 'resource' => array(
165 'location' => 'path',
166 'type' => 'string',
167 'required' => true,
168 ),
169 ),
170 ),'testIamPermissions' => array(
171 'path' => 'v1/{+resource}:testIamPermissions',
172 'httpMethod' => 'POST',
173 'parameters' => array(
174 'resource' => array(
175 'location' => 'path',
176 'type' => 'string',
177 'required' => true,
178 ),
179 ),
180 ),
181 )
182 )
183 );
184 $this->projects_topics = new Google_Service_Pubsub_ProjectsTopics_Resource(
185 $this,
186 $this->serviceName,
187 'topics',
188 array(
189 'methods' => array(
190 'create' => array(
191 'path' => 'v1/{+name}',
192 'httpMethod' => 'PUT',
193 'parameters' => array(
194 'name' => array(
195 'location' => 'path',
196 'type' => 'string',
197 'required' => true,
198 ),
199 ),
200 ),'delete' => array(
201 'path' => 'v1/{+topic}',
202 'httpMethod' => 'DELETE',
203 'parameters' => array(
204 'topic' => array(
205 'location' => 'path',
206 'type' => 'string',
207 'required' => true,
208 ),
209 ),
210 ),'get' => array(
211 'path' => 'v1/{+topic}',
212 'httpMethod' => 'GET',
213 'parameters' => array(
214 'topic' => array(
215 'location' => 'path',
216 'type' => 'string',
217 'required' => true,
218 ),
219 ),
220 ),'getIamPolicy' => array(
221 'path' => 'v1/{+resource}:getIamPolicy',
222 'httpMethod' => 'GET',
223 'parameters' => array(
224 'resource' => array(
225 'location' => 'path',
226 'type' => 'string',
227 'required' => true,
228 ),
229 ),
230 ),'list' => array(
231 'path' => 'v1/{+project}/topics',
232 'httpMethod' => 'GET',
233 'parameters' => array(
234 'project' => array(
235 'location' => 'path',
236 'type' => 'string',
237 'required' => true,
238 ),
239 'pageSize' => array(
240 'location' => 'query',
241 'type' => 'integer',
242 ),
243 'pageToken' => array(
244 'location' => 'query',
245 'type' => 'string',
246 ),
247 ),
248 ),'publish' => array(
249 'path' => 'v1/{+topic}:publish',
250 'httpMethod' => 'POST',
251 'parameters' => array(
252 'topic' => array(
253 'location' => 'path',
254 'type' => 'string',
255 'required' => true,
256 ),
257 ),
258 ),'setIamPolicy' => array(
259 'path' => 'v1/{+resource}:setIamPolicy',
260 'httpMethod' => 'POST',
261 'parameters' => array(
262 'resource' => array(
263 'location' => 'path',
264 'type' => 'string',
265 'required' => true,
266 ),
267 ),
268 ),'testIamPermissions' => array(
269 'path' => 'v1/{+resource}:testIamPermissions',
270 'httpMethod' => 'POST',
271 'parameters' => array(
272 'resource' => array(
273 'location' => 'path',
274 'type' => 'string',
275 'required' => true,
276 ),
277 ),
278 ),
279 )
280 )
281 );
282 $this->projects_topics_subscriptions = new Google_Service_Pubsub_ProjectsTopicsSubscriptions_Resource(
283 $this,
284 $this->serviceName,
285 'subscriptions',
286 array(
287 'methods' => array(
288 'list' => array(
289 'path' => 'v1/{+topic}/subscriptions',
290 'httpMethod' => 'GET',
291 'parameters' => array(
292 'topic' => array(
293 'location' => 'path',
294 'type' => 'string',
295 'required' => true,
296 ),
297 'pageSize' => array(
298 'location' => 'query',
299 'type' => 'integer',
300 ),
301 'pageToken' => array(
302 'location' => 'query',
303 'type' => 'string',
304 ),
305 ),
306 ),
307 )
308 )
309 );
310 }
311 }
312
313
314 /**
315 * The "projects" collection of methods.
316 * Typical usage is:
317 * <code>
318 * $pubsubService = new Google_Service_Pubsub(...);
319 * $projects = $pubsubService->projects;
320 * </code>
321 */
322 class Google_Service_Pubsub_Projects_Resource extends Google_Service_Resource
323 {
324 }
325
326 /**
327 * The "subscriptions" collection of methods.
328 * Typical usage is:
329 * <code>
330 * $pubsubService = new Google_Service_Pubsub(...);
331 * $subscriptions = $pubsubService->subscriptions;
332 * </code>
333 */
334 class Google_Service_Pubsub_ProjectsSubscriptions_Resource extends Google_Service_Resource
335 {
336
337 /**
338 * Acknowledges the messages associated with the `ack_ids` in the
339 * `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
340 * from the subscription. Acknowledging a message whose ack deadline has expired
341 * may succeed, but such a message may be redelivered later. Acknowledging a
342 * message more than once will not result in an error.
343 * (subscriptions.acknowledge)
344 *
345 * @param string $subscription The subscription whose message is being
346 * acknowledged.
347 * @param Google_AcknowledgeRequest $postBody
348 * @param array $optParams Optional parameters.
349 * @return Google_Service_Pubsub_Empty
350 */
351 public function acknowledge($subscription, Google_Service_Pubsub_AcknowledgeRequest $postBody, $optParams = array())
352 {
353 $params = array('subscription' => $subscription, 'postBody' => $postBody);
354 $params = array_merge($params, $optParams);
355 return $this->call('acknowledge', array($params), "Google_Service_Pubsub_Empty");
356 }
357
358 /**
359 * Creates a subscription to a given topic for a given subscriber. If the
360 * subscription already exists, returns `ALREADY_EXISTS`. If the corresponding
361 * topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the
362 * request, the server will assign a random name for this subscription on the
363 * same project as the topic. (subscriptions.create)
364 *
365 * @param string $name The name of the subscription. It must have the format
366 * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
367 * start with a letter, and contain only letters (`[A-Za-z]`), numbers
368 * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus
369 * (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
370 * length, and it must not start with `"goog"`.
371 * @param Google_Subscription $postBody
372 * @param array $optParams Optional parameters.
373 * @return Google_Service_Pubsub_Subscription
374 */
375 public function create($name, Google_Service_Pubsub_Subscription $postBody, $optParams = array())
376 {
377 $params = array('name' => $name, 'postBody' => $postBody);
378 $params = array_merge($params, $optParams);
379 return $this->call('create', array($params), "Google_Service_Pubsub_Subscription");
380 }
381
382 /**
383 * Deletes an existing subscription. All pending messages in the subscription
384 * are immediately dropped. Calls to `Pull` after deletion will return
385 * `NOT_FOUND`. After a subscription is deleted, a new one may be created with
386 * the same name, but the new one has no association with the old subscription,
387 * or its topic unless the same topic is specified. (subscriptions.delete)
388 *
389 * @param string $subscription The subscription to delete.
390 * @param array $optParams Optional parameters.
391 * @return Google_Service_Pubsub_Empty
392 */
393 public function delete($subscription, $optParams = array())
394 {
395 $params = array('subscription' => $subscription);
396 $params = array_merge($params, $optParams);
397 return $this->call('delete', array($params), "Google_Service_Pubsub_Empty");
398 }
399
400 /**
401 * Gets the configuration details of a subscription. (subscriptions.get)
402 *
403 * @param string $subscription The name of the subscription to get.
404 * @param array $optParams Optional parameters.
405 * @return Google_Service_Pubsub_Subscription
406 */
407 public function get($subscription, $optParams = array())
408 {
409 $params = array('subscription' => $subscription);
410 $params = array_merge($params, $optParams);
411 return $this->call('get', array($params), "Google_Service_Pubsub_Subscription");
412 }
413
414 /**
415 * Gets the access control policy for a `resource`. Is empty if the policy or
416 * the resource does not exist. (subscriptions.getIamPolicy)
417 *
418 * @param string $resource REQUIRED: The resource for which policy is being
419 * requested. `resource` is usually specified as a path, such as,
420 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
421 * specified in this value is resource specific and is specified in the
422 * documentation for the respective GetIamPolicy rpc.
423 * @param array $optParams Optional parameters.
424 * @return Google_Service_Pubsub_Policy
425 */
426 public function getIamPolicy($resource, $optParams = array())
427 {
428 $params = array('resource' => $resource);
429 $params = array_merge($params, $optParams);
430 return $this->call('getIamPolicy', array($params), "Google_Service_Pubsub_Policy");
431 }
432
433 /**
434 * Lists matching subscriptions. (subscriptions.listProjectsSubscriptions)
435 *
436 * @param string $project The name of the cloud project that subscriptions
437 * belong to.
438 * @param array $optParams Optional parameters.
439 *
440 * @opt_param int pageSize Maximum number of subscriptions to return.
441 * @opt_param string pageToken The value returned by the last
442 * `ListSubscriptionsResponse`; indicates that this is a continuation of a prior
443 * `ListSubscriptions` call, and that the system should return the next page of
444 * data.
445 * @return Google_Service_Pubsub_ListSubscriptionsResponse
446 */
447 public function listProjectsSubscriptions($project, $optParams = array())
448 {
449 $params = array('project' => $project);
450 $params = array_merge($params, $optParams);
451 return $this->call('list', array($params), "Google_Service_Pubsub_ListSubscriptionsResponse");
452 }
453
454 /**
455 * Modifies the ack deadline for a specific message. This method is useful to
456 * indicate that more time is needed to process a message by the subscriber, or
457 * to make the message available for redelivery if the processing was
458 * interrupted. (subscriptions.modifyAckDeadline)
459 *
460 * @param string $subscription The name of the subscription.
461 * @param Google_ModifyAckDeadlineRequest $postBody
462 * @param array $optParams Optional parameters.
463 * @return Google_Service_Pubsub_Empty
464 */
465 public function modifyAckDeadline($subscription, Google_Service_Pubsub_ModifyAckDeadlineRequest $postBody, $optParams = array())
466 {
467 $params = array('subscription' => $subscription, 'postBody' => $postBody);
468 $params = array_merge($params, $optParams);
469 return $this->call('modifyAckDeadline', array($params), "Google_Service_Pubsub_Empty");
470 }
471
472 /**
473 * Modifies the `PushConfig` for a specified subscription. This may be used to
474 * change a push subscription to a pull one (signified by an empty `PushConfig`)
475 * or vice versa, or change the endpoint URL and other attributes of a push
476 * subscription. Messages will accumulate for delivery continuously through the
477 * call regardless of changes to the `PushConfig`.
478 * (subscriptions.modifyPushConfig)
479 *
480 * @param string $subscription The name of the subscription.
481 * @param Google_ModifyPushConfigRequest $postBody
482 * @param array $optParams Optional parameters.
483 * @return Google_Service_Pubsub_Empty
484 */
485 public function modifyPushConfig($subscription, Google_Service_Pubsub_ModifyPushConfigRequest $postBody, $optParams = array())
486 {
487 $params = array('subscription' => $subscription, 'postBody' => $postBody);
488 $params = array_merge($params, $optParams);
489 return $this->call('modifyPushConfig', array($params), "Google_Service_Pubsub_Empty");
490 }
491
492 /**
493 * Pulls messages from the server. Returns an empty list if there are no
494 * messages available in the backlog. The server may return `UNAVAILABLE` if
495 * there are too many concurrent pull requests pending for the given
496 * subscription. (subscriptions.pull)
497 *
498 * @param string $subscription The subscription from which messages should be
499 * pulled.
500 * @param Google_PullRequest $postBody
501 * @param array $optParams Optional parameters.
502 * @return Google_Service_Pubsub_PullResponse
503 */
504 public function pull($subscription, Google_Service_Pubsub_PullRequest $postBody, $optParams = array())
505 {
506 $params = array('subscription' => $subscription, 'postBody' => $postBody);
507 $params = array_merge($params, $optParams);
508 return $this->call('pull', array($params), "Google_Service_Pubsub_PullResponse");
509 }
510
511 /**
512 * Sets the access control policy on the specified resource. Replaces any
513 * existing policy. (subscriptions.setIamPolicy)
514 *
515 * @param string $resource REQUIRED: The resource for which policy is being
516 * specified. `resource` is usually specified as a path, such as,
517 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
518 * specified in this value is resource specific and is specified in the
519 * documentation for the respective SetIamPolicy rpc.
520 * @param Google_SetIamPolicyRequest $postBody
521 * @param array $optParams Optional parameters.
522 * @return Google_Service_Pubsub_Policy
523 */
524 public function setIamPolicy($resource, Google_Service_Pubsub_SetIamPolicyRequest $postBody, $optParams = array())
525 {
526 $params = array('resource' => $resource, 'postBody' => $postBody);
527 $params = array_merge($params, $optParams);
528 return $this->call('setIamPolicy', array($params), "Google_Service_Pubsub_Policy");
529 }
530
531 /**
532 * Returns permissions that a caller has on the specified resource.
533 * (subscriptions.testIamPermissions)
534 *
535 * @param string $resource REQUIRED: The resource for which policy detail is
536 * being requested. `resource` is usually specified as a path, such as,
537 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
538 * specified in this value is resource specific and is specified in the
539 * documentation for the respective TestIamPermissions rpc.
540 * @param Google_TestIamPermissionsRequest $postBody
541 * @param array $optParams Optional parameters.
542 * @return Google_Service_Pubsub_TestIamPermissionsResponse
543 */
544 public function testIamPermissions($resource, Google_Service_Pubsub_TestIamPermissionsRequest $postBody, $optParams = array())
545 {
546 $params = array('resource' => $resource, 'postBody' => $postBody);
547 $params = array_merge($params, $optParams);
548 return $this->call('testIamPermissions', array($params), "Google_Service_Pubsub_TestIamPermissionsResponse");
549 }
550 }
551 /**
552 * The "topics" collection of methods.
553 * Typical usage is:
554 * <code>
555 * $pubsubService = new Google_Service_Pubsub(...);
556 * $topics = $pubsubService->topics;
557 * </code>
558 */
559 class Google_Service_Pubsub_ProjectsTopics_Resource extends Google_Service_Resource
560 {
561
562 /**
563 * Creates the given topic with the given name. (topics.create)
564 *
565 * @param string $name The name of the topic. It must have the format
566 * `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
567 * and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
568 * underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
569 * (`%`). It must be between 3 and 255 characters in length, and it must not
570 * start with `"goog"`.
571 * @param Google_Topic $postBody
572 * @param array $optParams Optional parameters.
573 * @return Google_Service_Pubsub_Topic
574 */
575 public function create($name, Google_Service_Pubsub_Topic $postBody, $optParams = array())
576 {
577 $params = array('name' => $name, 'postBody' => $postBody);
578 $params = array_merge($params, $optParams);
579 return $this->call('create', array($params), "Google_Service_Pubsub_Topic");
580 }
581
582 /**
583 * Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does
584 * not exist. After a topic is deleted, a new topic may be created with the same
585 * name; this is an entirely new topic with none of the old configuration or
586 * subscriptions. Existing subscriptions to this topic are not deleted, but
587 * their `topic` field is set to `_deleted-topic_`. (topics.delete)
588 *
589 * @param string $topic Name of the topic to delete.
590 * @param array $optParams Optional parameters.
591 * @return Google_Service_Pubsub_Empty
592 */
593 public function delete($topic, $optParams = array())
594 {
595 $params = array('topic' => $topic);
596 $params = array_merge($params, $optParams);
597 return $this->call('delete', array($params), "Google_Service_Pubsub_Empty");
598 }
599
600 /**
601 * Gets the configuration of a topic. (topics.get)
602 *
603 * @param string $topic The name of the topic to get.
604 * @param array $optParams Optional parameters.
605 * @return Google_Service_Pubsub_Topic
606 */
607 public function get($topic, $optParams = array())
608 {
609 $params = array('topic' => $topic);
610 $params = array_merge($params, $optParams);
611 return $this->call('get', array($params), "Google_Service_Pubsub_Topic");
612 }
613
614 /**
615 * Gets the access control policy for a `resource`. Is empty if the policy or
616 * the resource does not exist. (topics.getIamPolicy)
617 *
618 * @param string $resource REQUIRED: The resource for which policy is being
619 * requested. `resource` is usually specified as a path, such as,
620 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
621 * specified in this value is resource specific and is specified in the
622 * documentation for the respective GetIamPolicy rpc.
623 * @param array $optParams Optional parameters.
624 * @return Google_Service_Pubsub_Policy
625 */
626 public function getIamPolicy($resource, $optParams = array())
627 {
628 $params = array('resource' => $resource);
629 $params = array_merge($params, $optParams);
630 return $this->call('getIamPolicy', array($params), "Google_Service_Pubsub_Policy");
631 }
632
633 /**
634 * Lists matching topics. (topics.listProjectsTopics)
635 *
636 * @param string $project The name of the cloud project that topics belong to.
637 * @param array $optParams Optional parameters.
638 *
639 * @opt_param int pageSize Maximum number of topics to return.
640 * @opt_param string pageToken The value returned by the last
641 * `ListTopicsResponse`; indicates that this is a continuation of a prior
642 * `ListTopics` call, and that the system should return the next page of data.
643 * @return Google_Service_Pubsub_ListTopicsResponse
644 */
645 public function listProjectsTopics($project, $optParams = array())
646 {
647 $params = array('project' => $project);
648 $params = array_merge($params, $optParams);
649 return $this->call('list', array($params), "Google_Service_Pubsub_ListTopicsResponse");
650 }
651
652 /**
653 * Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does
654 * not exist. The message payload must not be empty; it must contain either a
655 * non-empty data field, or at least one attribute. (topics.publish)
656 *
657 * @param string $topic The messages in the request will be published on this
658 * topic.
659 * @param Google_PublishRequest $postBody
660 * @param array $optParams Optional parameters.
661 * @return Google_Service_Pubsub_PublishResponse
662 */
663 public function publish($topic, Google_Service_Pubsub_PublishRequest $postBody, $optParams = array())
664 {
665 $params = array('topic' => $topic, 'postBody' => $postBody);
666 $params = array_merge($params, $optParams);
667 return $this->call('publish', array($params), "Google_Service_Pubsub_PublishResponse");
668 }
669
670 /**
671 * Sets the access control policy on the specified resource. Replaces any
672 * existing policy. (topics.setIamPolicy)
673 *
674 * @param string $resource REQUIRED: The resource for which policy is being
675 * specified. `resource` is usually specified as a path, such as,
676 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
677 * specified in this value is resource specific and is specified in the
678 * documentation for the respective SetIamPolicy rpc.
679 * @param Google_SetIamPolicyRequest $postBody
680 * @param array $optParams Optional parameters.
681 * @return Google_Service_Pubsub_Policy
682 */
683 public function setIamPolicy($resource, Google_Service_Pubsub_SetIamPolicyRequest $postBody, $optParams = array())
684 {
685 $params = array('resource' => $resource, 'postBody' => $postBody);
686 $params = array_merge($params, $optParams);
687 return $this->call('setIamPolicy', array($params), "Google_Service_Pubsub_Policy");
688 }
689
690 /**
691 * Returns permissions that a caller has on the specified resource.
692 * (topics.testIamPermissions)
693 *
694 * @param string $resource REQUIRED: The resource for which policy detail is
695 * being requested. `resource` is usually specified as a path, such as,
696 * `projects/{project}/zones/{zone}/disks/{disk}`. The format for the path
697 * specified in this value is resource specific and is specified in the
698 * documentation for the respective TestIamPermissions rpc.
699 * @param Google_TestIamPermissionsRequest $postBody
700 * @param array $optParams Optional parameters.
701 * @return Google_Service_Pubsub_TestIamPermissionsResponse
702 */
703 public function testIamPermissions($resource, Google_Service_Pubsub_TestIamPermissionsRequest $postBody, $optParams = array())
704 {
705 $params = array('resource' => $resource, 'postBody' => $postBody);
706 $params = array_merge($params, $optParams);
707 return $this->call('testIamPermissions', array($params), "Google_Service_Pubsub_TestIamPermissionsResponse");
708 }
709 }
710
711 /**
712 * The "subscriptions" collection of methods.
713 * Typical usage is:
714 * <code>
715 * $pubsubService = new Google_Service_Pubsub(...);
716 * $subscriptions = $pubsubService->subscriptions;
717 * </code>
718 */
719 class Google_Service_Pubsub_ProjectsTopicsSubscriptions_Resource extends Google_Service_Resource
720 {
721
722 /**
723 * Lists the name of the subscriptions for this topic.
724 * (subscriptions.listProjectsTopicsSubscriptions)
725 *
726 * @param string $topic The name of the topic that subscriptions are attached
727 * to.
728 * @param array $optParams Optional parameters.
729 *
730 * @opt_param int pageSize Maximum number of subscription names to return.
731 * @opt_param string pageToken The value returned by the last
732 * `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a
733 * prior `ListTopicSubscriptions` call, and that the system should return the
734 * next page of data.
735 * @return Google_Service_Pubsub_ListTopicSubscriptionsResponse
736 */
737 public function listProjectsTopicsSubscriptions($topic, $optParams = array())
738 {
739 $params = array('topic' => $topic);
740 $params = array_merge($params, $optParams);
741 return $this->call('list', array($params), "Google_Service_Pubsub_ListTopicSubscriptionsResponse");
742 }
743 }
744
745
746
747
748 class Google_Service_Pubsub_AcknowledgeRequest extends Google_Collection
749 {
750 protected $collection_key = 'ackIds';
751 protected $internal_gapi_mappings = array(
752 );
753 public $ackIds;
754
755
756 public function setAckIds($ackIds)
757 {
758 $this->ackIds = $ackIds;
759 }
760 public function getAckIds()
761 {
762 return $this->ackIds;
763 }
764 }
765
766 class Google_Service_Pubsub_Binding extends Google_Collection
767 {
768 protected $collection_key = 'members';
769 protected $internal_gapi_mappings = array(
770 );
771 public $members;
772 public $role;
773
774
775 public function setMembers($members)
776 {
777 $this->members = $members;
778 }
779 public function getMembers()
780 {
781 return $this->members;
782 }
783 public function setRole($role)
784 {
785 $this->role = $role;
786 }
787 public function getRole()
788 {
789 return $this->role;
790 }
791 }
792
793 class Google_Service_Pubsub_Empty extends Google_Model
794 {
795 }
796
797 class Google_Service_Pubsub_ListSubscriptionsResponse extends Google_Collection
798 {
799 protected $collection_key = 'subscriptions';
800 protected $internal_gapi_mappings = array(
801 );
802 public $nextPageToken;
803 protected $subscriptionsType = 'Google_Service_Pubsub_Subscription';
804 protected $subscriptionsDataType = 'array';
805
806
807 public function setNextPageToken($nextPageToken)
808 {
809 $this->nextPageToken = $nextPageToken;
810 }
811 public function getNextPageToken()
812 {
813 return $this->nextPageToken;
814 }
815 public function setSubscriptions($subscriptions)
816 {
817 $this->subscriptions = $subscriptions;
818 }
819 public function getSubscriptions()
820 {
821 return $this->subscriptions;
822 }
823 }
824
825 class Google_Service_Pubsub_ListTopicSubscriptionsResponse extends Google_Collection
826 {
827 protected $collection_key = 'subscriptions';
828 protected $internal_gapi_mappings = array(
829 );
830 public $nextPageToken;
831 public $subscriptions;
832
833
834 public function setNextPageToken($nextPageToken)
835 {
836 $this->nextPageToken = $nextPageToken;
837 }
838 public function getNextPageToken()
839 {
840 return $this->nextPageToken;
841 }
842 public function setSubscriptions($subscriptions)
843 {
844 $this->subscriptions = $subscriptions;
845 }
846 public function getSubscriptions()
847 {
848 return $this->subscriptions;
849 }
850 }
851
852 class Google_Service_Pubsub_ListTopicsResponse extends Google_Collection
853 {
854 protected $collection_key = 'topics';
855 protected $internal_gapi_mappings = array(
856 );
857 public $nextPageToken;
858 protected $topicsType = 'Google_Service_Pubsub_Topic';
859 protected $topicsDataType = 'array';
860
861
862 public function setNextPageToken($nextPageToken)
863 {
864 $this->nextPageToken = $nextPageToken;
865 }
866 public function getNextPageToken()
867 {
868 return $this->nextPageToken;
869 }
870 public function setTopics($topics)
871 {
872 $this->topics = $topics;
873 }
874 public function getTopics()
875 {
876 return $this->topics;
877 }
878 }
879
880 class Google_Service_Pubsub_ModifyAckDeadlineRequest extends Google_Collection
881 {
882 protected $collection_key = 'ackIds';
883 protected $internal_gapi_mappings = array(
884 );
885 public $ackDeadlineSeconds;
886 public $ackIds;
887
888
889 public function setAckDeadlineSeconds($ackDeadlineSeconds)
890 {
891 $this->ackDeadlineSeconds = $ackDeadlineSeconds;
892 }
893 public function getAckDeadlineSeconds()
894 {
895 return $this->ackDeadlineSeconds;
896 }
897 public function setAckIds($ackIds)
898 {
899 $this->ackIds = $ackIds;
900 }
901 public function getAckIds()
902 {
903 return $this->ackIds;
904 }
905 }
906
907 class Google_Service_Pubsub_ModifyPushConfigRequest extends Google_Model
908 {
909 protected $internal_gapi_mappings = array(
910 );
911 protected $pushConfigType = 'Google_Service_Pubsub_PushConfig';
912 protected $pushConfigDataType = '';
913
914
915 public function setPushConfig(Google_Service_Pubsub_PushConfig $pushConfig)
916 {
917 $this->pushConfig = $pushConfig;
918 }
919 public function getPushConfig()
920 {
921 return $this->pushConfig;
922 }
923 }
924
925 class Google_Service_Pubsub_Policy extends Google_Collection
926 {
927 protected $collection_key = 'bindings';
928 protected $internal_gapi_mappings = array(
929 );
930 protected $bindingsType = 'Google_Service_Pubsub_Binding';
931 protected $bindingsDataType = 'array';
932 public $etag;
933 public $version;
934
935
936 public function setBindings($bindings)
937 {
938 $this->bindings = $bindings;
939 }
940 public function getBindings()
941 {
942 return $this->bindings;
943 }
944 public function setEtag($etag)
945 {
946 $this->etag = $etag;
947 }
948 public function getEtag()
949 {
950 return $this->etag;
951 }
952 public function setVersion($version)
953 {
954 $this->version = $version;
955 }
956 public function getVersion()
957 {
958 return $this->version;
959 }
960 }
961
962 class Google_Service_Pubsub_PublishRequest extends Google_Collection
963 {
964 protected $collection_key = 'messages';
965 protected $internal_gapi_mappings = array(
966 );
967 protected $messagesType = 'Google_Service_Pubsub_PubsubMessage';
968 protected $messagesDataType = 'array';
969
970
971 public function setMessages($messages)
972 {
973 $this->messages = $messages;
974 }
975 public function getMessages()
976 {
977 return $this->messages;
978 }
979 }
980
981 class Google_Service_Pubsub_PublishResponse extends Google_Collection
982 {
983 protected $collection_key = 'messageIds';
984 protected $internal_gapi_mappings = array(
985 );
986 public $messageIds;
987
988
989 public function setMessageIds($messageIds)
990 {
991 $this->messageIds = $messageIds;
992 }
993 public function getMessageIds()
994 {
995 return $this->messageIds;
996 }
997 }
998
999 class Google_Service_Pubsub_PubsubMessage extends Google_Model
1000 {
1001 protected $internal_gapi_mappings = array(
1002 );
1003 public $attributes;
1004 public $data;
1005 public $messageId;
1006 public $publishTime;
1007
1008
1009 public function setAttributes($attributes)
1010 {
1011 $this->attributes = $attributes;
1012 }
1013 public function getAttributes()
1014 {
1015 return $this->attributes;
1016 }
1017 public function setData($data)
1018 {
1019 $this->data = $data;
1020 }
1021 public function getData()
1022 {
1023 return $this->data;
1024 }
1025 public function setMessageId($messageId)
1026 {
1027 $this->messageId = $messageId;
1028 }
1029 public function getMessageId()
1030 {
1031 return $this->messageId;
1032 }
1033 public function setPublishTime($publishTime)
1034 {
1035 $this->publishTime = $publishTime;
1036 }
1037 public function getPublishTime()
1038 {
1039 return $this->publishTime;
1040 }
1041 }
1042
1043 class Google_Service_Pubsub_PullRequest extends Google_Model
1044 {
1045 protected $internal_gapi_mappings = array(
1046 );
1047 public $maxMessages;
1048 public $returnImmediately;
1049
1050
1051 public function setMaxMessages($maxMessages)
1052 {
1053 $this->maxMessages = $maxMessages;
1054 }
1055 public function getMaxMessages()
1056 {
1057 return $this->maxMessages;
1058 }
1059 public function setReturnImmediately($returnImmediately)
1060 {
1061 $this->returnImmediately = $returnImmediately;
1062 }
1063 public function getReturnImmediately()
1064 {
1065 return $this->returnImmediately;
1066 }
1067 }
1068
1069 class Google_Service_Pubsub_PullResponse extends Google_Collection
1070 {
1071 protected $collection_key = 'receivedMessages';
1072 protected $internal_gapi_mappings = array(
1073 );
1074 protected $receivedMessagesType = 'Google_Service_Pubsub_ReceivedMessage';
1075 protected $receivedMessagesDataType = 'array';
1076
1077
1078 public function setReceivedMessages($receivedMessages)
1079 {
1080 $this->receivedMessages = $receivedMessages;
1081 }
1082 public function getReceivedMessages()
1083 {
1084 return $this->receivedMessages;
1085 }
1086 }
1087
1088 class Google_Service_Pubsub_PushConfig extends Google_Model
1089 {
1090 protected $internal_gapi_mappings = array(
1091 );
1092 public $attributes;
1093 public $pushEndpoint;
1094
1095
1096 public function setAttributes($attributes)
1097 {
1098 $this->attributes = $attributes;
1099 }
1100 public function getAttributes()
1101 {
1102 return $this->attributes;
1103 }
1104 public function setPushEndpoint($pushEndpoint)
1105 {
1106 $this->pushEndpoint = $pushEndpoint;
1107 }
1108 public function getPushEndpoint()
1109 {
1110 return $this->pushEndpoint;
1111 }
1112 }
1113
1114 class Google_Service_Pubsub_ReceivedMessage extends Google_Model
1115 {
1116 protected $internal_gapi_mappings = array(
1117 );
1118 public $ackId;
1119 protected $messageType = 'Google_Service_Pubsub_PubsubMessage';
1120 protected $messageDataType = '';
1121
1122
1123 public function setAckId($ackId)
1124 {
1125 $this->ackId = $ackId;
1126 }
1127 public function getAckId()
1128 {
1129 return $this->ackId;
1130 }
1131 public function setMessage(Google_Service_Pubsub_PubsubMessage $message)
1132 {
1133 $this->message = $message;
1134 }
1135 public function getMessage()
1136 {
1137 return $this->message;
1138 }
1139 }
1140
1141 class Google_Service_Pubsub_SetIamPolicyRequest extends Google_Model
1142 {
1143 protected $internal_gapi_mappings = array(
1144 );
1145 protected $policyType = 'Google_Service_Pubsub_Policy';
1146 protected $policyDataType = '';
1147
1148
1149 public function setPolicy(Google_Service_Pubsub_Policy $policy)
1150 {
1151 $this->policy = $policy;
1152 }
1153 public function getPolicy()
1154 {
1155 return $this->policy;
1156 }
1157 }
1158
1159 class Google_Service_Pubsub_Subscription extends Google_Model
1160 {
1161 protected $internal_gapi_mappings = array(
1162 );
1163 public $ackDeadlineSeconds;
1164 public $name;
1165 protected $pushConfigType = 'Google_Service_Pubsub_PushConfig';
1166 protected $pushConfigDataType = '';
1167 public $topic;
1168
1169
1170 public function setAckDeadlineSeconds($ackDeadlineSeconds)
1171 {
1172 $this->ackDeadlineSeconds = $ackDeadlineSeconds;
1173 }
1174 public function getAckDeadlineSeconds()
1175 {
1176 return $this->ackDeadlineSeconds;
1177 }
1178 public function setName($name)
1179 {
1180 $this->name = $name;
1181 }
1182 public function getName()
1183 {
1184 return $this->name;
1185 }
1186 public function setPushConfig(Google_Service_Pubsub_PushConfig $pushConfig)
1187 {
1188 $this->pushConfig = $pushConfig;
1189 }
1190 public function getPushConfig()
1191 {
1192 return $this->pushConfig;
1193 }
1194 public function setTopic($topic)
1195 {
1196 $this->topic = $topic;
1197 }
1198 public function getTopic()
1199 {
1200 return $this->topic;
1201 }
1202 }
1203
1204 class Google_Service_Pubsub_TestIamPermissionsRequest extends Google_Collection
1205 {
1206 protected $collection_key = 'permissions';
1207 protected $internal_gapi_mappings = array(
1208 );
1209 public $permissions;
1210
1211
1212 public function setPermissions($permissions)
1213 {
1214 $this->permissions = $permissions;
1215 }
1216 public function getPermissions()
1217 {
1218 return $this->permissions;
1219 }
1220 }
1221
1222 class Google_Service_Pubsub_TestIamPermissionsResponse extends Google_Collection
1223 {
1224 protected $collection_key = 'permissions';
1225 protected $internal_gapi_mappings = array(
1226 );
1227 public $permissions;
1228
1229
1230 public function setPermissions($permissions)
1231 {
1232 $this->permissions = $permissions;
1233 }
1234 public function getPermissions()
1235 {
1236 return $this->permissions;
1237 }
1238 }
1239
1240 class Google_Service_Pubsub_Topic extends Google_Model
1241 {
1242 protected $internal_gapi_mappings = array(
1243 );
1244 public $name;
1245
1246
1247 public function setName($name)
1248 {
1249 $this->name = $name;
1250 }
1251 public function getName()
1252 {
1253 return $this->name;
1254 }
1255 }
1256