SubscriberClient

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

Formats a string containing the fully-qualified path to represent a subscription 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 subscription resource.

Parses the subscription from the given fully-qualified path which represents a subscription 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 a subscription to a given topic.

If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Sample code:

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();
    }
}

Gets the configuration details of a subscription.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $response = $subscriberClient->getSubscription($formattedSubscription);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

Lists matching subscriptions.

Sample code:

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

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.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $subscriberClient->deleteSubscription($formattedSubscription);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

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.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $ackIds = [];
    $ackDeadlineSeconds = 0;
    $subscriberClient->modifyAckDeadline($formattedSubscription, $ackIds, $ackDeadlineSeconds);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $ackIds = [];
    $subscriberClient->acknowledge($formattedSubscription, $ackIds);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

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.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $maxMessages = 0;
    $response = $subscriberClient->pull($formattedSubscription, $maxMessages);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

Modifies the PushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedSubscription = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $pushConfig = new PushConfig();
    $subscriberClient->modifyPushConfig($formattedSubscription, $pushConfig);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

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

Sample code:

try {
    $subscriberClient = new SubscriberClient();
    $formattedResource = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $policy = new Policy();
    $response = $subscriberClient->setIamPolicy($formattedResource, $policy);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->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 {
    $subscriberClient = new SubscriberClient();
    $formattedResource = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $response = $subscriberClient->getIamPolicy($formattedResource);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->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 {
    $subscriberClient = new SubscriberClient();
    $formattedResource = SubscriberClient::formatSubscriptionName("[PROJECT]", "[SUBSCRIPTION]");
    $permissions = [];
    $response = $subscriberClient->testIamPermissions($formattedResource, $permissions);
} finally {
    if (isset($subscriberClient)) {
        $subscriberClient->close();
    }
}

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