Reference documentation and code samples for the Cloud PubSub V1 Client class ModifyAckDeadlineRequest.
Request for the ModifyAckDeadline method.
Generated from protobuf messagegoogle.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 isprojects/{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 theModifyAckDeadlinecall 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).
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 theModifyAckDeadlinecall 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 theModifyAckDeadlinecall 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 isprojects/{project}/subscriptions/{sub}. Please seeSubscriberClient::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 theModifyAckDeadlinecall 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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class ModifyAckDeadlineRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.ModifyAckDeadlineRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.ModifyAckDeadlineRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.ModifyAckDeadlineRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.ModifyAckDeadlineRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.ModifyAckDeadlineRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.ModifyAckDeadlineRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.ModifyAckDeadlineRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.ModifyAckDeadlineRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.ModifyAckDeadlineRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.ModifyAckDeadlineRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.ModifyAckDeadlineRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.ModifyAckDeadlineRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.ModifyAckDeadlineRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.ModifyAckDeadlineRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.ModifyAckDeadlineRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.ModifyAckDeadlineRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.ModifyAckDeadlineRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.ModifyAckDeadlineRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.ModifyAckDeadlineRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.ModifyAckDeadlineRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.ModifyAckDeadlineRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.ModifyAckDeadlineRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.ModifyAckDeadlineRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.ModifyAckDeadlineRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.ModifyAckDeadlineRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.ModifyAckDeadlineRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class ModifyAckDeadlineRequest.\n\nRequest for the ModifyAckDeadline method.\n\nGenerated from protobuf message `google.pubsub.v1.ModifyAckDeadlineRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSubscription\n\nRequired. The name of the subscription.\n\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### setSubscription\n\nRequired. The name of the subscription.\n\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### getAckIds\n\nRequired. List of acknowledgment IDs.\n\n### setAckIds\n\nRequired. List of acknowledgment IDs.\n\n### getAckDeadlineSeconds\n\nRequired. The new ack deadline with respect to the time this request was\nsent to the Pub/Sub system. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the `ModifyAckDeadline` call was\nmade. Specifying zero might immediately make the message available for\ndelivery to another subscriber client. This typically results in an\nincrease in the rate of message redeliveries (that is, duplicates).\n\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify in a single request is 600 seconds\n(10 minutes).\n\n### setAckDeadlineSeconds\n\nRequired. The new ack deadline with respect to the time this request was\nsent to the Pub/Sub system. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the `ModifyAckDeadline` call was\nmade. Specifying zero might immediately make the message available for\ndelivery to another subscriber client. This typically results in an\nincrease in the rate of message redeliveries (that is, duplicates).\n\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify in a single request is 600 seconds\n(10 minutes).\n\n### static::build"]]
