Cloud PubSub V1 Client - Class ModifyAckDeadlineRequest (2.8.2)

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

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}.
↳ 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 in a single request is 600 seconds (10 minutes).

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

getAckIds

Required. List of acknowledgment IDs.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAckIds

Required. List of acknowledgment IDs.

Parameter
Name Description
var string[]
Returns
Type Description
$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 in a single request is 600 seconds (10 minutes).

Returns
Type Description
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 in a single request is 600 seconds (10 minutes).

Parameter
Name Description
var int
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 SubscriberClient::subscriptionName() for help formatting this field.
ackIds string[]

Required. List of acknowledgment IDs.
ackDeadlineSeconds 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 in a single request is 600 seconds (10 minutes).
Returns
Type Description
ModifyAckDeadlineRequest