PHPXRef 0.7.1 : moodle-2.8 : Detail view of Pubsub.php

(no description)

File Size:	831 lines (22 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 17 classes

Google_Service_Pubsub:: (1 method):
__construct()

Google_Service_Pubsub_Subscriptions_Resource:: (8 methods):
  acknowledge()
  create()
  delete()
  get()
  listSubscriptions()
  modifyAckDeadline()
  modifyPushConfig()
  pull()

Google_Service_Pubsub_Topics_Resource:: (5 methods):
  create()
  delete()
  get()
  listTopics()
  publish()

Google_Service_Pubsub_AcknowledgeRequest:: (4 methods):
  setAckId()
  getAckId()
  setSubscription()
  getSubscription()

Google_Service_Pubsub_Label:: (6 methods):
  setKey()
  getKey()
  setNumValue()
  getNumValue()
  setStrValue()
  getStrValue()

Google_Service_Pubsub_ListSubscriptionsResponse:: (4 methods):
  setNextPageToken()
  getNextPageToken()
  setSubscription()
  getSubscription()

Google_Service_Pubsub_ListTopicsResponse:: (4 methods):
  setNextPageToken()
  getNextPageToken()
  setTopic()
  getTopic()

Google_Service_Pubsub_ModifyAckDeadlineRequest:: (6 methods):
  setAckDeadlineSeconds()
  getAckDeadlineSeconds()
  setAckId()
  getAckId()
  setSubscription()
  getSubscription()

Google_Service_Pubsub_ModifyPushConfigRequest:: (4 methods):
  setPushConfig()
  getPushConfig()
  setSubscription()
  getSubscription()

Google_Service_Pubsub_PublishRequest:: (4 methods):
  setMessage()
  getMessage()
  setTopic()
  getTopic()

Google_Service_Pubsub_PubsubEvent:: (8 methods):
  setDeleted()
  getDeleted()
  setMessage()
  getMessage()
  setSubscription()
  getSubscription()
  setTruncated()
  getTruncated()

Google_Service_Pubsub_PubsubMessage:: (4 methods):
  setData()
  getData()
  setLabel()
  getLabel()

Google_Service_Pubsub_PullRequest:: (4 methods):
  setReturnImmediately()
  getReturnImmediately()
  setSubscription()
  getSubscription()

Google_Service_Pubsub_PullResponse:: (4 methods):
  setAckId()
  getAckId()
  setPubsubEvent()
  getPubsubEvent()

Google_Service_Pubsub_PushConfig:: (2 methods):
setPushEndpoint()
getPushEndpoint()

Google_Service_Pubsub_Subscription:: (8 methods):
  setAckDeadlineSeconds()
  getAckDeadlineSeconds()
  setName()
  getName()
  setPushConfig()
  getPushConfig()
  setTopic()
  getTopic()

Google_Service_Pubsub_Topic:: (2 methods):
setName()
getName()

Class: Google_Service_Pubsub - X-Ref

Service definition for Pubsub (v1beta1).

<p>
Provides reliable, many-to-many, asynchronous messaging between applications.
</p>

<p>
For more information about this service, see the API
<a href="https://developers.google.com/pubsub/v1beta1" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client) X-Ref

Constructs the internal representation of the Pubsub service.

param: Google_Client $client

Class: Google_Service_Pubsub_Subscriptions_Resource - X-Ref

The "subscriptions" collection of methods.
Typical usage is:
<code>
$pubsubService = new Google_Service_Pubsub(...);
$subscriptions = $pubsubService->subscriptions;
</code>

acknowledge(Google_Service_Pubsub_AcknowledgeRequest $postBody, $optParams = array() X-Ref

Acknowledges a particular received message: the Pub/Sub system can remove the
given message from the subscription. Acknowledging a message whose Ack
deadline has expired may succeed, but the message could have been already
redelivered. Acknowledging a message more than once will not result in an
error. This is only used for messages received via pull.
(subscriptions.acknowledge)

param: Google_AcknowledgeRequest $postBody
param: array $optParams Optional parameters.

create(Google_Service_Pubsub_Subscription $postBody, $optParams = array() X-Ref

Creates a subscription on a given topic for a given subscriber. If the
subscription already exists, returns ALREADY_EXISTS. If the corresponding
topic doesn't exist, returns NOT_FOUND. (subscriptions.create)

param: Google_Subscription $postBody
param: array $optParams Optional parameters.
return: Google_Service_Pubsub_Subscription

delete($subscription, $optParams = array() X-Ref

Deletes an existing subscription. All pending messages in the subscription
are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.
(subscriptions.delete)

param: string $subscription
param: array $optParams Optional parameters.

get($subscription, $optParams = array() X-Ref

Gets the configuration details of a subscription. (subscriptions.get)

param: string $subscription
param: array $optParams Optional parameters.
return: Google_Service_Pubsub_Subscription

listSubscriptions($optParams = array() X-Ref

Lists matching subscriptions. (subscriptions.listSubscriptions)

param: array $optParams Optional parameters.
return: Google_Service_Pubsub_ListSubscriptionsResponse

modifyAckDeadline(Google_Service_Pubsub_ModifyAckDeadlineRequest $postBody, $optParams = array() X-Ref

Modifies the Ack deadline for a message received from a pull request.
(subscriptions.modifyAckDeadline)

param: Google_ModifyAckDeadlineRequest $postBody
param: array $optParams Optional parameters.

modifyPushConfig(Google_Service_Pubsub_ModifyPushConfigRequest $postBody, $optParams = array() X-Ref

Modifies the PushConfig for a specified subscription. This method can be used
to suspend the flow of messages to an end point by clearing the PushConfig
field in the request. Messages will be accumulated for delivery even if no
push configuration is defined or while the configuration is modified.
(subscriptions.modifyPushConfig)

param: Google_ModifyPushConfigRequest $postBody
param: array $optParams Optional parameters.

pull(Google_Service_Pubsub_PullRequest $postBody, $optParams = array() X-Ref

Pulls a single message from the server. If return_immediately is true, and no
messages are available in the subscription, this method returns
FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no
messages are available in a reasonable amount of time (to reduce system
load). (subscriptions.pull)

param: Google_PullRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Pubsub_PullResponse

Class: Google_Service_Pubsub_Topics_Resource - X-Ref

The "topics" collection of methods.
Typical usage is:
<code>
$pubsubService = new Google_Service_Pubsub(...);
$topics = $pubsubService->topics;
</code>

create(Google_Service_Pubsub_Topic $postBody, $optParams = array() X-Ref

Creates the given topic with the given name. (topics.create)

param: Google_Topic $postBody
param: array $optParams Optional parameters.
return: Google_Service_Pubsub_Topic

delete($topic, $optParams = array() X-Ref

Deletes the topic with the given name. All subscriptions to this topic are
also deleted. Returns NOT_FOUND if the topic does not exist. After a topic is
deleted, a new topic may be created with the same name. (topics.delete)

param: string $topic
param: array $optParams Optional parameters.

get($topic, $optParams = array() X-Ref

Gets the configuration of a topic. Since the topic only has the name
attribute, this method is only useful to check the existence of a topic. If
other attributes are added in the future, they will be returned here.
(topics.get)

param: string $topic
param: array $optParams Optional parameters.
return: Google_Service_Pubsub_Topic

listTopics($optParams = array() X-Ref

Lists matching topics. (topics.listTopics)

param: array $optParams Optional parameters.
return: Google_Service_Pubsub_ListTopicsResponse

publish(Google_Service_Pubsub_PublishRequest $postBody, $optParams = array() X-Ref

Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
(topics.publish)

param: Google_PublishRequest $postBody
param: array $optParams Optional parameters.

Class: Google_Service_Pubsub_AcknowledgeRequest - X-Ref

setAckId($ackId) X-Ref

No description

getAckId() X-Ref

No description

setSubscription($subscription) X-Ref

No description

getSubscription() X-Ref

No description

Class: Google_Service_Pubsub_Label - X-Ref

setKey($key) X-Ref

No description