Cloud PubSub V1 Client - Class ModifyPushConfigRequest (1.39.3)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}.

Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setSubscription

Required. The name of the subscription.

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

Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\PubSub\V1\PushConfig|null

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.

Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\PubSub\V1\PushConfig
Returns
TypeDescription
$this