• Home
• Google
• Cloud
• PubSub
• V1
• PublisherClient

PHP Class Google\Cloud\PubSub\V1\PublisherClient

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 { $publisherClient = new PublisherClient(); $formattedName = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]"); $response = $publisherClient->createTopic($formattedName); } finally { if (isset($publisherClient)) { $publisherClient->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.
close ( )	Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
createTopic ( string $name, array $optionalArgs = [] ) : google\pubsub\v1\Topic	Creates the given topic with the given name.
deleteTopic ( string $topic, array $optionalArgs = [] )	Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to _deleted-topic_.
formatProjectName ( $project )	Formats a string containing the fully-qualified path to represent a project 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.
getTopic ( string $topic, array $optionalArgs = [] ) : google\pubsub\v1\Topic	Gets the configuration of a topic.
listTopicSubscriptions ( string $topic, array $optionalArgs = [] ) : Google\GAX\PagedListResponse	Lists the name of the subscriptions for this topic.
listTopics ( string $project, array $optionalArgs = [] ) : Google\GAX\PagedListResponse	Lists matching topics.
parseProjectFromProjectName ( $projectName )	Parses the project from the given fully-qualified path which represents a project resource.
parseProjectFromTopicName ( $topicName )	Parses the project from the given fully-qualified path which represents a topic resource.
parseTopicFromTopicName ( $topicName )	Parses the topic from the given fully-qualified path which represents a topic resource.
publish ( string $topic, google\pubsub\v1\PubsubMessage[] $messages, array $optionalArgs = [] ) : google\pubsub\v1\PublishResponse	Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
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 ( )
getTopicNameTemplate ( )

Method Details