Cloud PubSub V1 Client - Class ModifyPushConfigRequest (2.7.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class ModifyPushConfigRequest.

Request for the ModifyPushConfig method.

Generated from protobuf message google.pubsub.v1.ModifyPushConfigRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ subscription
string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub} .

↳ push_config
Google\Cloud\PubSub\V1\PushConfig

Required. The push configuration for future deliveries. An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

getSubscription

Required. The name of the subscription.

Format is projects/{project}/subscriptions/{sub} .

Returns
Type
Description
string

setSubscription

Required. The name of the subscription.

Format is projects/{project}/subscriptions/{sub} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPushConfig

Required. The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

Returns
Type
Description

hasPushConfig

clearPushConfig

setPushConfig

Required. The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

Parameter
Name
Description
Returns
Type
Description
$this

static::build

Parameters
Name
Description
subscription
string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub} . Please see Google\Cloud\PubSub\V1\SubscriberClient::subscriptionName() for help formatting this field.

pushConfig
Google\Cloud\PubSub\V1\PushConfig

Required. The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

Design a Mobile Site
View Site in Mobile | Classic
Share by: