Cloud PubSub V1 Client - Class ModifyAckDeadlineRequest (1.39.3)

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

Request for the ModifyAckDeadline method.

Generated from protobuf message google.pubsub.v1.ModifyAckDeadlineRequest

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

↳ ack_ids array

Required. List of acknowledgment IDs.

↳ ack_deadline_seconds int

Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

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

getAckIds

Required. List of acknowledgment IDs.

Generated from protobuf field repeated string ack_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAckIds

Required. List of acknowledgment IDs.

Generated from protobuf field repeated string ack_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getAckDeadlineSeconds

Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates).

The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

Generated from protobuf field int32 ack_deadline_seconds = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

setAckDeadlineSeconds

Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates).

The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

Generated from protobuf field int32 ack_deadline_seconds = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var int
Returns
TypeDescription
$this