Documentation

Google_Service_Pubsub_Resource_ProjectsSubscriptions extends Google_Service_Resource
in package

Application

The "subscriptions" collection of methods.

Typical usage is: $pubsubService = new Google_Service_Pubsub(...); $subscriptions = $pubsubService->subscriptions;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
acknowledge() : Google_Service_Pubsub_PubsubEmpty: 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.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Pubsub_Subscription: Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. (subscriptions.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Pubsub_PubsubEmpty: 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. (subscriptions.delete)
detach() : Google_Service_Pubsub_DetachSubscriptionResponse: Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop. (subscriptions.detach)
get() : Google_Service_Pubsub_Subscription: Gets the configuration details of a subscription. (subscriptions.get)
getIamPolicy() : Google_Service_Pubsub_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (subscriptions.getIamPolicy)
listProjectsSubscriptions() : Google_Service_Pubsub_ListSubscriptionsResponse: Lists matching subscriptions. (subscriptions.listProjectsSubscriptions)
modifyAckDeadline() : Google_Service_Pubsub_PubsubEmpty: 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() : Google_Service_Pubsub_PubsubEmpty: 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`.
patch() : Google_Service_Pubsub_Subscription: Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. (subscriptions.patch)
pull() : Google_Service_Pubsub_PullResponse: Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
seek() : Google_Service_Pubsub_SeekResponse: Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. (subscriptions.seek)
setIamPolicy() : Google_Service_Pubsub_Policy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (subscriptions.setIamPolicy)
testIamPermissions() : Google_Service_Pubsub_TestIamPermissionsResponse: 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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

acknowledge()

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.


    public
                acknowledge(string $subscription, Google_Service_Pubsub_AcknowledgeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_PubsubEmpty

(subscriptions.acknowledge)

Parameters

$subscription : string: Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.
$postBody : Google_Service_Pubsub_AcknowledgeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_PubsubEmpty —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. (subscriptions.create)


    public
                create(string $name, Google_Service_Pubsub_Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_Subscription

Parameters

$name : string: Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
$postBody : Google_Service_Pubsub_Subscription
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_Subscription —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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. (subscriptions.delete)


    public
                delete(string $subscription[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_PubsubEmpty

Parameters

$subscription : string: Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_PubsubEmpty —

detach()

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop. (subscriptions.detach)


    public
                detach(string $subscription[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_DetachSubscriptionResponse

Parameters

$subscription : string: Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_DetachSubscriptionResponse —

get()

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


    public
                get(string $subscription[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_Subscription

Parameters

$subscription : string: Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_Subscription —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (subscriptions.getIamPolicy)


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_Policy —

listProjectsSubscriptions()

Lists matching subscriptions. (subscriptions.listProjectsSubscriptions)


    public
                listProjectsSubscriptions(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_ListSubscriptionsResponse

Parameters

$project : string: Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_ListSubscriptionsResponse —

modifyAckDeadline()

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.


    public
                modifyAckDeadline(string $subscription, Google_Service_Pubsub_ModifyAckDeadlineRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_PubsubEmpty

(subscriptions.modifyAckDeadline)

Parameters

$subscription : string: Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
$postBody : Google_Service_Pubsub_ModifyAckDeadlineRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_PubsubEmpty —

modifyPushConfig()

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


    public
                modifyPushConfig(string $subscription, Google_Service_Pubsub_ModifyPushConfigRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_PubsubEmpty

(subscriptions.modifyPushConfig)

Parameters

$subscription : string: Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
$postBody : Google_Service_Pubsub_ModifyPushConfigRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_PubsubEmpty —

patch()

Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. (subscriptions.patch)


    public
                patch(string $name, Google_Service_Pubsub_UpdateSubscriptionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_Subscription

Parameters

$name : string: Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
$postBody : Google_Service_Pubsub_UpdateSubscriptionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_Subscription —

pull()

Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.


    public
                pull(string $subscription, Google_Service_Pubsub_PullRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_PullResponse

(subscriptions.pull)

Parameters

$subscription : string: Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.
$postBody : Google_Service_Pubsub_PullRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_PullResponse —

seek()

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. (subscriptions.seek)


    public
                seek(string $subscription, Google_Service_Pubsub_SeekRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_SeekResponse

Parameters

$subscription : string: Required. The subscription to affect.
$postBody : Google_Service_Pubsub_SeekRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_SeekResponse —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (subscriptions.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_Pubsub_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Pubsub_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_Policy —

testIamPermissions()

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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_Pubsub_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Pubsub_TestIamPermissionsResponse

This operation may "fail open" without warning. (subscriptions.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Pubsub_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Pubsub_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —