[ Index ] |
PHP Cross Reference of moodle-2.8 |
[Summary view] [Print] [Text view]
1 <?php 2 /* 3 * Copyright 2010 Google Inc. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 6 * use this file except in compliance with the License. You may obtain a copy of 7 * the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 * License for the specific language governing permissions and limitations under 15 * the License. 16 */ 17 18 /** 19 * Service definition for Pubsub (v1beta1). 20 * 21 * <p> 22 * Provides reliable, many-to-many, asynchronous messaging between applications. 23 * </p> 24 * 25 * <p> 26 * For more information about this service, see the API 27 * <a href="https://developers.google.com/pubsub/v1beta1" target="_blank">Documentation</a> 28 * </p> 29 * 30 * @author Google, Inc. 31 */ 32 class Google_Service_Pubsub extends Google_Service 33 { 34 /** View and manage your data across Google Cloud Platform services. */ 35 const CLOUD_PLATFORM = "https://www.googleapis.com/auth/cloud-platform"; 36 /** View and manage Pub/Sub topics and subscriptions. */ 37 const PUBSUB = "https://www.googleapis.com/auth/pubsub"; 38 39 public $subscriptions; 40 public $topics; 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->servicePath = 'pubsub/v1beta1/'; 52 $this->version = 'v1beta1'; 53 $this->serviceName = 'pubsub'; 54 55 $this->subscriptions = new Google_Service_Pubsub_Subscriptions_Resource( 56 $this, 57 $this->serviceName, 58 'subscriptions', 59 array( 60 'methods' => array( 61 'acknowledge' => array( 62 'path' => 'subscriptions/acknowledge', 63 'httpMethod' => 'POST', 64 'parameters' => array(), 65 ),'create' => array( 66 'path' => 'subscriptions', 67 'httpMethod' => 'POST', 68 'parameters' => array(), 69 ),'delete' => array( 70 'path' => 'subscriptions/{+subscription}', 71 'httpMethod' => 'DELETE', 72 'parameters' => array( 73 'subscription' => array( 74 'location' => 'path', 75 'type' => 'string', 76 'required' => true, 77 ), 78 ), 79 ),'get' => array( 80 'path' => 'subscriptions/{+subscription}', 81 'httpMethod' => 'GET', 82 'parameters' => array( 83 'subscription' => array( 84 'location' => 'path', 85 'type' => 'string', 86 'required' => true, 87 ), 88 ), 89 ),'list' => array( 90 'path' => 'subscriptions', 91 'httpMethod' => 'GET', 92 'parameters' => array( 93 'pageToken' => array( 94 'location' => 'query', 95 'type' => 'string', 96 ), 97 'maxResults' => array( 98 'location' => 'query', 99 'type' => 'integer', 100 ), 101 'query' => array( 102 'location' => 'query', 103 'type' => 'string', 104 ), 105 ), 106 ),'modifyAckDeadline' => array( 107 'path' => 'subscriptions/modifyAckDeadline', 108 'httpMethod' => 'POST', 109 'parameters' => array(), 110 ),'modifyPushConfig' => array( 111 'path' => 'subscriptions/modifyPushConfig', 112 'httpMethod' => 'POST', 113 'parameters' => array(), 114 ),'pull' => array( 115 'path' => 'subscriptions/pull', 116 'httpMethod' => 'POST', 117 'parameters' => array(), 118 ), 119 ) 120 ) 121 ); 122 $this->topics = new Google_Service_Pubsub_Topics_Resource( 123 $this, 124 $this->serviceName, 125 'topics', 126 array( 127 'methods' => array( 128 'create' => array( 129 'path' => 'topics', 130 'httpMethod' => 'POST', 131 'parameters' => array(), 132 ),'delete' => array( 133 'path' => 'topics/{+topic}', 134 'httpMethod' => 'DELETE', 135 'parameters' => array( 136 'topic' => array( 137 'location' => 'path', 138 'type' => 'string', 139 'required' => true, 140 ), 141 ), 142 ),'get' => array( 143 'path' => 'topics/{+topic}', 144 'httpMethod' => 'GET', 145 'parameters' => array( 146 'topic' => array( 147 'location' => 'path', 148 'type' => 'string', 149 'required' => true, 150 ), 151 ), 152 ),'list' => array( 153 'path' => 'topics', 154 'httpMethod' => 'GET', 155 'parameters' => array( 156 'pageToken' => array( 157 'location' => 'query', 158 'type' => 'string', 159 ), 160 'maxResults' => array( 161 'location' => 'query', 162 'type' => 'integer', 163 ), 164 'query' => array( 165 'location' => 'query', 166 'type' => 'string', 167 ), 168 ), 169 ),'publish' => array( 170 'path' => 'topics/publish', 171 'httpMethod' => 'POST', 172 'parameters' => array(), 173 ), 174 ) 175 ) 176 ); 177 } 178 } 179 180 181 /** 182 * The "subscriptions" collection of methods. 183 * Typical usage is: 184 * <code> 185 * $pubsubService = new Google_Service_Pubsub(...); 186 * $subscriptions = $pubsubService->subscriptions; 187 * </code> 188 */ 189 class Google_Service_Pubsub_Subscriptions_Resource extends Google_Service_Resource 190 { 191 192 /** 193 * Acknowledges a particular received message: the Pub/Sub system can remove the 194 * given message from the subscription. Acknowledging a message whose Ack 195 * deadline has expired may succeed, but the message could have been already 196 * redelivered. Acknowledging a message more than once will not result in an 197 * error. This is only used for messages received via pull. 198 * (subscriptions.acknowledge) 199 * 200 * @param Google_AcknowledgeRequest $postBody 201 * @param array $optParams Optional parameters. 202 */ 203 public function acknowledge(Google_Service_Pubsub_AcknowledgeRequest $postBody, $optParams = array()) 204 { 205 $params = array('postBody' => $postBody); 206 $params = array_merge($params, $optParams); 207 return $this->call('acknowledge', array($params)); 208 } 209 /** 210 * Creates a subscription on a given topic for a given subscriber. If the 211 * subscription already exists, returns ALREADY_EXISTS. If the corresponding 212 * topic doesn't exist, returns NOT_FOUND. (subscriptions.create) 213 * 214 * @param Google_Subscription $postBody 215 * @param array $optParams Optional parameters. 216 * @return Google_Service_Pubsub_Subscription 217 */ 218 public function create(Google_Service_Pubsub_Subscription $postBody, $optParams = array()) 219 { 220 $params = array('postBody' => $postBody); 221 $params = array_merge($params, $optParams); 222 return $this->call('create', array($params), "Google_Service_Pubsub_Subscription"); 223 } 224 /** 225 * Deletes an existing subscription. All pending messages in the subscription 226 * are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. 227 * (subscriptions.delete) 228 * 229 * @param string $subscription 230 * The subscription to delete. 231 * @param array $optParams Optional parameters. 232 */ 233 public function delete($subscription, $optParams = array()) 234 { 235 $params = array('subscription' => $subscription); 236 $params = array_merge($params, $optParams); 237 return $this->call('delete', array($params)); 238 } 239 /** 240 * Gets the configuration details of a subscription. (subscriptions.get) 241 * 242 * @param string $subscription 243 * The name of the subscription to get. 244 * @param array $optParams Optional parameters. 245 * @return Google_Service_Pubsub_Subscription 246 */ 247 public function get($subscription, $optParams = array()) 248 { 249 $params = array('subscription' => $subscription); 250 $params = array_merge($params, $optParams); 251 return $this->call('get', array($params), "Google_Service_Pubsub_Subscription"); 252 } 253 /** 254 * Lists matching subscriptions. (subscriptions.listSubscriptions) 255 * 256 * @param array $optParams Optional parameters. 257 * 258 * @opt_param string pageToken 259 * The value obtained in the last ListSubscriptionsResponse for continuation. 260 * @opt_param int maxResults 261 * Maximum number of subscriptions to return. 262 * @opt_param string query 263 * A valid label query expression. 264 * @return Google_Service_Pubsub_ListSubscriptionsResponse 265 */ 266 public function listSubscriptions($optParams = array()) 267 { 268 $params = array(); 269 $params = array_merge($params, $optParams); 270 return $this->call('list', array($params), "Google_Service_Pubsub_ListSubscriptionsResponse"); 271 } 272 /** 273 * Modifies the Ack deadline for a message received from a pull request. 274 * (subscriptions.modifyAckDeadline) 275 * 276 * @param Google_ModifyAckDeadlineRequest $postBody 277 * @param array $optParams Optional parameters. 278 */ 279 public function modifyAckDeadline(Google_Service_Pubsub_ModifyAckDeadlineRequest $postBody, $optParams = array()) 280 { 281 $params = array('postBody' => $postBody); 282 $params = array_merge($params, $optParams); 283 return $this->call('modifyAckDeadline', array($params)); 284 } 285 /** 286 * Modifies the PushConfig for a specified subscription. This method can be used 287 * to suspend the flow of messages to an end point by clearing the PushConfig 288 * field in the request. Messages will be accumulated for delivery even if no 289 * push configuration is defined or while the configuration is modified. 290 * (subscriptions.modifyPushConfig) 291 * 292 * @param Google_ModifyPushConfigRequest $postBody 293 * @param array $optParams Optional parameters. 294 */ 295 public function modifyPushConfig(Google_Service_Pubsub_ModifyPushConfigRequest $postBody, $optParams = array()) 296 { 297 $params = array('postBody' => $postBody); 298 $params = array_merge($params, $optParams); 299 return $this->call('modifyPushConfig', array($params)); 300 } 301 /** 302 * Pulls a single message from the server. If return_immediately is true, and no 303 * messages are available in the subscription, this method returns 304 * FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no 305 * messages are available in a reasonable amount of time (to reduce system 306 * load). (subscriptions.pull) 307 * 308 * @param Google_PullRequest $postBody 309 * @param array $optParams Optional parameters. 310 * @return Google_Service_Pubsub_PullResponse 311 */ 312 public function pull(Google_Service_Pubsub_PullRequest $postBody, $optParams = array()) 313 { 314 $params = array('postBody' => $postBody); 315 $params = array_merge($params, $optParams); 316 return $this->call('pull', array($params), "Google_Service_Pubsub_PullResponse"); 317 } 318 } 319 320 /** 321 * The "topics" collection of methods. 322 * Typical usage is: 323 * <code> 324 * $pubsubService = new Google_Service_Pubsub(...); 325 * $topics = $pubsubService->topics; 326 * </code> 327 */ 328 class Google_Service_Pubsub_Topics_Resource extends Google_Service_Resource 329 { 330 331 /** 332 * Creates the given topic with the given name. (topics.create) 333 * 334 * @param Google_Topic $postBody 335 * @param array $optParams Optional parameters. 336 * @return Google_Service_Pubsub_Topic 337 */ 338 public function create(Google_Service_Pubsub_Topic $postBody, $optParams = array()) 339 { 340 $params = array('postBody' => $postBody); 341 $params = array_merge($params, $optParams); 342 return $this->call('create', array($params), "Google_Service_Pubsub_Topic"); 343 } 344 /** 345 * Deletes the topic with the given name. All subscriptions to this topic are 346 * also deleted. Returns NOT_FOUND if the topic does not exist. After a topic is 347 * deleted, a new topic may be created with the same name. (topics.delete) 348 * 349 * @param string $topic 350 * Name of the topic to delete. 351 * @param array $optParams Optional parameters. 352 */ 353 public function delete($topic, $optParams = array()) 354 { 355 $params = array('topic' => $topic); 356 $params = array_merge($params, $optParams); 357 return $this->call('delete', array($params)); 358 } 359 /** 360 * Gets the configuration of a topic. Since the topic only has the name 361 * attribute, this method is only useful to check the existence of a topic. If 362 * other attributes are added in the future, they will be returned here. 363 * (topics.get) 364 * 365 * @param string $topic 366 * The name of the topic to get. 367 * @param array $optParams Optional parameters. 368 * @return Google_Service_Pubsub_Topic 369 */ 370 public function get($topic, $optParams = array()) 371 { 372 $params = array('topic' => $topic); 373 $params = array_merge($params, $optParams); 374 return $this->call('get', array($params), "Google_Service_Pubsub_Topic"); 375 } 376 /** 377 * Lists matching topics. (topics.listTopics) 378 * 379 * @param array $optParams Optional parameters. 380 * 381 * @opt_param string pageToken 382 * The value obtained in the last ListTopicsResponse for continuation. 383 * @opt_param int maxResults 384 * Maximum number of topics to return. 385 * @opt_param string query 386 * A valid label query expression. 387 * @return Google_Service_Pubsub_ListTopicsResponse 388 */ 389 public function listTopics($optParams = array()) 390 { 391 $params = array(); 392 $params = array_merge($params, $optParams); 393 return $this->call('list', array($params), "Google_Service_Pubsub_ListTopicsResponse"); 394 } 395 /** 396 * Adds a message to the topic. Returns NOT_FOUND if the topic does not exist. 397 * (topics.publish) 398 * 399 * @param Google_PublishRequest $postBody 400 * @param array $optParams Optional parameters. 401 */ 402 public function publish(Google_Service_Pubsub_PublishRequest $postBody, $optParams = array()) 403 { 404 $params = array('postBody' => $postBody); 405 $params = array_merge($params, $optParams); 406 return $this->call('publish', array($params)); 407 } 408 } 409 410 411 412 413 class Google_Service_Pubsub_AcknowledgeRequest extends Google_Collection 414 { 415 protected $collection_key = 'ackId'; 416 public $ackId; 417 public $subscription; 418 419 public function setAckId($ackId) 420 { 421 $this->ackId = $ackId; 422 } 423 424 public function getAckId() 425 { 426 return $this->ackId; 427 } 428 429 public function setSubscription($subscription) 430 { 431 $this->subscription = $subscription; 432 } 433 434 public function getSubscription() 435 { 436 return $this->subscription; 437 } 438 } 439 440 class Google_Service_Pubsub_Label extends Google_Model 441 { 442 public $key; 443 public $numValue; 444 public $strValue; 445 446 public function setKey($key) 447 { 448 $this->key = $key; 449 } 450 451 public function getKey() 452 { 453 return $this->key; 454 } 455 456 public function setNumValue($numValue) 457 { 458 $this->numValue = $numValue; 459 } 460 461 public function getNumValue() 462 { 463 return $this->numValue; 464 } 465 466 public function setStrValue($strValue) 467 { 468 $this->strValue = $strValue; 469 } 470 471 public function getStrValue() 472 { 473 return $this->strValue; 474 } 475 } 476 477 class Google_Service_Pubsub_ListSubscriptionsResponse extends Google_Collection 478 { 479 protected $collection_key = 'subscription'; 480 public $nextPageToken; 481 protected $subscriptionType = 'Google_Service_Pubsub_Subscription'; 482 protected $subscriptionDataType = 'array'; 483 484 public function setNextPageToken($nextPageToken) 485 { 486 $this->nextPageToken = $nextPageToken; 487 } 488 489 public function getNextPageToken() 490 { 491 return $this->nextPageToken; 492 } 493 494 public function setSubscription($subscription) 495 { 496 $this->subscription = $subscription; 497 } 498 499 public function getSubscription() 500 { 501 return $this->subscription; 502 } 503 } 504 505 class Google_Service_Pubsub_ListTopicsResponse extends Google_Collection 506 { 507 protected $collection_key = 'topic'; 508 public $nextPageToken; 509 protected $topicType = 'Google_Service_Pubsub_Topic'; 510 protected $topicDataType = 'array'; 511 512 public function setNextPageToken($nextPageToken) 513 { 514 $this->nextPageToken = $nextPageToken; 515 } 516 517 public function getNextPageToken() 518 { 519 return $this->nextPageToken; 520 } 521 522 public function setTopic($topic) 523 { 524 $this->topic = $topic; 525 } 526 527 public function getTopic() 528 { 529 return $this->topic; 530 } 531 } 532 533 class Google_Service_Pubsub_ModifyAckDeadlineRequest extends Google_Model 534 { 535 public $ackDeadlineSeconds; 536 public $ackId; 537 public $subscription; 538 539 public function setAckDeadlineSeconds($ackDeadlineSeconds) 540 { 541 $this->ackDeadlineSeconds = $ackDeadlineSeconds; 542 } 543 544 public function getAckDeadlineSeconds() 545 { 546 return $this->ackDeadlineSeconds; 547 } 548 549 public function setAckId($ackId) 550 { 551 $this->ackId = $ackId; 552 } 553 554 public function getAckId() 555 { 556 return $this->ackId; 557 } 558 559 public function setSubscription($subscription) 560 { 561 $this->subscription = $subscription; 562 } 563 564 public function getSubscription() 565 { 566 return $this->subscription; 567 } 568 } 569 570 class Google_Service_Pubsub_ModifyPushConfigRequest extends Google_Model 571 { 572 protected $pushConfigType = 'Google_Service_Pubsub_PushConfig'; 573 protected $pushConfigDataType = ''; 574 public $subscription; 575 576 public function setPushConfig(Google_Service_Pubsub_PushConfig $pushConfig) 577 { 578 $this->pushConfig = $pushConfig; 579 } 580 581 public function getPushConfig() 582 { 583 return $this->pushConfig; 584 } 585 586 public function setSubscription($subscription) 587 { 588 $this->subscription = $subscription; 589 } 590 591 public function getSubscription() 592 { 593 return $this->subscription; 594 } 595 } 596 597 class Google_Service_Pubsub_PublishRequest extends Google_Model 598 { 599 protected $messageType = 'Google_Service_Pubsub_PubsubMessage'; 600 protected $messageDataType = ''; 601 public $topic; 602 603 public function setMessage(Google_Service_Pubsub_PubsubMessage $message) 604 { 605 $this->message = $message; 606 } 607 608 public function getMessage() 609 { 610 return $this->message; 611 } 612 613 public function setTopic($topic) 614 { 615 $this->topic = $topic; 616 } 617 618 public function getTopic() 619 { 620 return $this->topic; 621 } 622 } 623 624 class Google_Service_Pubsub_PubsubEvent extends Google_Model 625 { 626 public $deleted; 627 protected $messageType = 'Google_Service_Pubsub_PubsubMessage'; 628 protected $messageDataType = ''; 629 public $subscription; 630 public $truncated; 631 632 public function setDeleted($deleted) 633 { 634 $this->deleted = $deleted; 635 } 636 637 public function getDeleted() 638 { 639 return $this->deleted; 640 } 641 642 public function setMessage(Google_Service_Pubsub_PubsubMessage $message) 643 { 644 $this->message = $message; 645 } 646 647 public function getMessage() 648 { 649 return $this->message; 650 } 651 652 public function setSubscription($subscription) 653 { 654 $this->subscription = $subscription; 655 } 656 657 public function getSubscription() 658 { 659 return $this->subscription; 660 } 661 662 public function setTruncated($truncated) 663 { 664 $this->truncated = $truncated; 665 } 666 667 public function getTruncated() 668 { 669 return $this->truncated; 670 } 671 } 672 673 class Google_Service_Pubsub_PubsubMessage extends Google_Collection 674 { 675 protected $collection_key = 'label'; 676 public $data; 677 protected $labelType = 'Google_Service_Pubsub_Label'; 678 protected $labelDataType = 'array'; 679 680 public function setData($data) 681 { 682 $this->data = $data; 683 } 684 685 public function getData() 686 { 687 return $this->data; 688 } 689 690 public function setLabel($label) 691 { 692 $this->label = $label; 693 } 694 695 public function getLabel() 696 { 697 return $this->label; 698 } 699 } 700 701 class Google_Service_Pubsub_PullRequest extends Google_Model 702 { 703 public $returnImmediately; 704 public $subscription; 705 706 public function setReturnImmediately($returnImmediately) 707 { 708 $this->returnImmediately = $returnImmediately; 709 } 710 711 public function getReturnImmediately() 712 { 713 return $this->returnImmediately; 714 } 715 716 public function setSubscription($subscription) 717 { 718 $this->subscription = $subscription; 719 } 720 721 public function getSubscription() 722 { 723 return $this->subscription; 724 } 725 } 726 727 class Google_Service_Pubsub_PullResponse extends Google_Model 728 { 729 public $ackId; 730 protected $pubsubEventType = 'Google_Service_Pubsub_PubsubEvent'; 731 protected $pubsubEventDataType = ''; 732 733 public function setAckId($ackId) 734 { 735 $this->ackId = $ackId; 736 } 737 738 public function getAckId() 739 { 740 return $this->ackId; 741 } 742 743 public function setPubsubEvent(Google_Service_Pubsub_PubsubEvent $pubsubEvent) 744 { 745 $this->pubsubEvent = $pubsubEvent; 746 } 747 748 public function getPubsubEvent() 749 { 750 return $this->pubsubEvent; 751 } 752 } 753 754 class Google_Service_Pubsub_PushConfig extends Google_Model 755 { 756 public $pushEndpoint; 757 758 public function setPushEndpoint($pushEndpoint) 759 { 760 $this->pushEndpoint = $pushEndpoint; 761 } 762 763 public function getPushEndpoint() 764 { 765 return $this->pushEndpoint; 766 } 767 } 768 769 class Google_Service_Pubsub_Subscription extends Google_Model 770 { 771 public $ackDeadlineSeconds; 772 public $name; 773 protected $pushConfigType = 'Google_Service_Pubsub_PushConfig'; 774 protected $pushConfigDataType = ''; 775 public $topic; 776 777 public function setAckDeadlineSeconds($ackDeadlineSeconds) 778 { 779 $this->ackDeadlineSeconds = $ackDeadlineSeconds; 780 } 781 782 public function getAckDeadlineSeconds() 783 { 784 return $this->ackDeadlineSeconds; 785 } 786 787 public function setName($name) 788 { 789 $this->name = $name; 790 } 791 792 public function getName() 793 { 794 return $this->name; 795 } 796 797 public function setPushConfig(Google_Service_Pubsub_PushConfig $pushConfig) 798 { 799 $this->pushConfig = $pushConfig; 800 } 801 802 public function getPushConfig() 803 { 804 return $this->pushConfig; 805 } 806 807 public function setTopic($topic) 808 { 809 $this->topic = $topic; 810 } 811 812 public function getTopic() 813 { 814 return $this->topic; 815 } 816 } 817 818 class Google_Service_Pubsub_Topic extends Google_Model 819 { 820 public $name; 821 822 public function setName($name) 823 { 824 $this->name = $name; 825 } 826 827 public function getName() 828 { 829 return $this->name; 830 } 831 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |