Subscription
class Subscription extends Message
A subscription resource.
Protobuf type Google\Pubsub\V1\Subscription
Methods
No description
The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}". {subscription} must
start with a letter, and contain only letters ([A-Za-z]), numbers
([0-9]), dashes (-), underscores (_), periods (.), tildes (~),
plus (+) or percent signs (%). It must be between 3 and 255 characters
in length, and it must not start with "goog".
The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}". {subscription} must
start with a letter, and contain only letters ([A-Za-z]), numbers
([0-9]), dashes (-), underscores (_), periods (.), tildes (~),
plus (+) or percent signs (%). It must be between 3 and 255 characters
in length, and it must not start with "goog".
The name of the topic from which this subscription is receiving messages.
The name of the topic from which this subscription is receiving messages.
If push delivery is used with this subscription, this field is
used to configure it. An empty pushConfig signifies that the subscriber
will pull and ack messages using API methods.
If push delivery is used with this subscription, this field is
used to configure it. An empty pushConfig signifies that the subscriber
will pull and ack messages using API methods.
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the message_retention_duration
window.
Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the message_retention_duration
window.
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
Details
at line 88
__construct()
at line 104
string
getName()
The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}". {subscription} must
start with a letter, and contain only letters ([A-Za-z]), numbers
([0-9]), dashes (-), underscores (_), periods (.), tildes (~),
plus (+) or percent signs (%). It must be between 3 and 255 characters
in length, and it must not start with "goog".
Generated from protobuf field string name = 1;
at line 120
setName(string $var)
The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}". {subscription} must
start with a letter, and contain only letters ([A-Za-z]), numbers
([0-9]), dashes (-), underscores (_), periods (.), tildes (~),
plus (+) or percent signs (%). It must be between 3 and 255 characters
in length, and it must not start with "goog".
Generated from protobuf field string name = 1;
at line 135
string
getTopic()
The name of the topic from which this subscription is receiving messages.
Format is projects/{project}/topics/{topic}.
The value of this field will be _deleted-topic_ if the topic has been
deleted.
Generated from protobuf field string topic = 2;
at line 149
setTopic(string $var)
The name of the topic from which this subscription is receiving messages.
Format is projects/{project}/topics/{topic}.
The value of this field will be _deleted-topic_ if the topic has been
deleted.
Generated from protobuf field string topic = 2;
at line 163
PushConfig
getPushConfig()
If push delivery is used with this subscription, this field is
used to configure it. An empty pushConfig signifies that the subscriber
will pull and ack messages using API methods.
Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4;
at line 176
setPushConfig(PushConfig $var)
If push delivery is used with this subscription, this field is
used to configure it. An empty pushConfig signifies that the subscriber
will pull and ack messages using API methods.
Generated from protobuf field .google.pubsub.v1.PushConfig push_config = 4;
at line 203
int
getAckDeadlineSeconds()
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack
deadline. To override this value for a given message, call
ModifyAckDeadline with the corresponding ack_id if using
pull.
The minimum custom deadline you can specify is 10 seconds.
The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for
the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub
system will eventually redeliver the message.
Generated from protobuf field int32 ack_deadline_seconds = 5;
at line 229
setAckDeadlineSeconds(int $var)
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack
deadline. To override this value for a given message, call
ModifyAckDeadline with the corresponding ack_id if using
pull.
The minimum custom deadline you can specify is 10 seconds.
The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for
the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub
system will eventually redeliver the message.
Generated from protobuf field int32 ack_deadline_seconds = 5;
at line 244
bool
getRetainAckedMessages()
Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the message_retention_duration
window.
Generated from protobuf field bool retain_acked_messages = 7;
at line 258
setRetainAckedMessages(bool $var)
Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the message_retention_duration
window.
Generated from protobuf field bool retain_acked_messages = 7;
at line 275
Duration
getMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
If retain_acked_messages is true, then this also configures the retention
of acknowledged messages, and thus configures how far back in time a Seek
can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
minutes.
Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8;
at line 291
setMessageRetentionDuration(Duration $var)
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
If retain_acked_messages is true, then this also configures the retention
of acknowledged messages, and thus configures how far back in time a Seek
can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
minutes.
Generated from protobuf field .google.protobuf.Duration message_retention_duration = 8;