• Home
• Google
• Cloud
• PubSub
• V1
• SubscriberClient

PHP Class Google\Cloud\PubSub\V1\SubscriberClient

EXPERIMENTAL: this client library class has not yet been declared beta. This class may change more frequently than those which have been declared beta or 1.0, including changes which break backwards compatibility. This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: try { $subscriberClient = new SubscriberClient(); $formattedName = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]"); $formattedTopic = SubscriberClient::formatTopicName("[PROJECT]", "[TOPIC]"); $response = $subscriberClient->createSubscription($formattedName, $formattedTopic); } finally { if (isset($subscriberClient)) { $subscriberClient->close(); } } Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned. Datei anzeigen Open project: GoogleCloudPlatform/gcloud-php

Public Methods

Method	Description
__construct ( array $options = [] )	Constructor.
acknowledge ( string $subscription, string[] $ackIds, array $optionalArgs = [] )	Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.
close ( )	Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
createSubscription ( string $name, string $topic, array $optionalArgs = [] ) : google\pubsub\v1\Subscription	Creates a subscription to a given topic.
deleteSubscription ( string $subscription, array $optionalArgs = [] )	Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
formatProjectName ( $project )	Formats a string containing the fully-qualified path to represent a project resource.
formatSubscriptionName ( $project, $subscription )	Formats a string containing the fully-qualified path to represent a subscription resource.
formatTopicName ( $project, $topic )	Formats a string containing the fully-qualified path to represent a topic resource.
getIamPolicy ( string $resource, array $optionalArgs = [] ) : google\iam\v1\Policy	Gets the access control policy for a resource.
getSubscription ( string $subscription, array $optionalArgs = [] ) : google\pubsub\v1\Subscription	Gets the configuration details of a subscription.
listSubscriptions ( string $project, array $optionalArgs = [] ) : Google\GAX\PagedListResponse	Lists matching subscriptions.
modifyAckDeadline ( string $subscription, string[] $ackIds, integer $ackDeadlineSeconds, array $optionalArgs = [] )	Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.
modifyPushConfig ( string $subscription, google\pubsub\v1\PushConfig $pushConfig, array $optionalArgs = [] )	Modifies the PushConfig for a specified subscription.
parseProjectFromProjectName ( $projectName )	Parses the project from the given fully-qualified path which represents a project resource.
parseProjectFromSubscriptionName ( $subscriptionName )	Parses the project from the given fully-qualified path which represents a subscription resource.
parseProjectFromTopicName ( $topicName )	Parses the project from the given fully-qualified path which represents a topic resource.
parseSubscriptionFromSubscriptionName ( $subscriptionName )	Parses the subscription from the given fully-qualified path which represents a subscription resource.
parseTopicFromTopicName ( $topicName )	Parses the topic from the given fully-qualified path which represents a topic resource.
pull ( string $subscription, integer $maxMessages, array $optionalArgs = [] ) : google\pubsub\v1\PullResponse	Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.
setIamPolicy ( string $resource, google\iam\v1\Policy $policy, array $optionalArgs = [] ) : google\iam\v1\Policy	Sets the access control policy on the specified resource. Replaces any existing policy.
testIamPermissions ( string $resource, string[] $permissions, array $optionalArgs = [] ) : google\iam\v1\TestIamPermissionsResponse	Returns permissions that a caller has on the specified resource.

Private Methods

Method	Description
createCredentialsCallback ( )
getPageStreamingDescriptors ( )
getProjectNameTemplate ( )
getSubscriptionNameTemplate ( )
getTopicNameTemplate ( )

Method Details