PublisherClient

Formats a string containing the fully-qualified path to represent a project resource.

Formats a string containing the fully-qualified path to represent a topic resource.

Parses the project from the given fully-qualified path which represents a project resource.

Parses the project from the given fully-qualified path which represents a topic resource.

Parses the topic from the given fully-qualified path which represents a topic resource.

Constructor.

Creates the given topic with the given name.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedName = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $response = $publisherClient->createTopic($formattedName);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

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.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedTopic = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $data = "";
    $messagesElement = new PubsubMessage();
    $messagesElement->setData($data);
    $messages = [$messagesElement];
    $response = $publisherClient->publish($formattedTopic, $messages);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Gets the configuration of a topic.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedTopic = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $response = $publisherClient->getTopic($formattedTopic);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Lists matching topics.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedProject = PublisherClient::formatProjectName("[PROJECT]");
    foreach ($publisherClient->listTopics($formattedProject)->iterateAllElements() as $element) {
        // doThingsWith(element);
    }
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Lists the name of the subscriptions for this topic.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedTopic = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    foreach ($publisherClient->listTopicSubscriptions($formattedTopic)->iterateAllElements() as $element) {
        // doThingsWith(element);
    }
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

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_.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedTopic = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $publisherClient->deleteTopic($formattedTopic);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedResource = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $policy = new Policy();
    $response = $publisherClient->setIamPolicy($formattedResource, $policy);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedResource = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $response = $publisherClient->getIamPolicy($formattedResource);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Sample code:

try {
    $publisherClient = new PublisherClient();
    $formattedResource = PublisherClient::formatTopicName("[PROJECT]", "[TOPIC]");
    $permissions = [];
    $response = $publisherClient->testIamPermissions($formattedResource, $permissions);
} finally {
    if (isset($publisherClient)) {
        $publisherClient->close();
    }
}

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.