Reference documentation and code samples for the Cloud PubSub V1 Client class Subscription.
A subscription resource. If none of push_config
, bigquery_config
, or
cloud_storage_config
is set, then the subscriber will pull and ack messages
using API methods. At most one of these fields may be set.
Generated from protobuf message google.pubsub.v1.Subscription
Namespace
Google \ Cloud \ PubSub \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the subscription. It must have the format |
↳ topic |
string
Required. The name of the topic from which this subscription is receiving messages. Format is |
↳ push_config |
Google\Cloud\PubSub\V1\PushConfig
If push delivery is used with this subscription, this field is used to configure it. |
↳ bigquery_config |
Google\Cloud\PubSub\V1\BigQueryConfig
If delivery to BigQuery is used with this subscription, this field is used to configure it. |
↳ cloud_storage_config |
Google\Cloud\PubSub\V1\CloudStorageConfig
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. |
↳ ack_deadline_seconds |
int
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 |
↳ retain_acked_messages |
bool
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 |
Google\Protobuf\Duration
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If |
↳ labels |
array|Google\Protobuf\Internal\MapField
|
↳ enable_message_ordering |
bool
If true, messages published with the same |
↳ expiration_policy |
Google\Cloud\PubSub\V1\ExpirationPolicy
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If |
↳ filter |
string
An expression written in the Pub/Sub filter language. If non-empty, then only |
↳ dead_letter_policy |
Google\Cloud\PubSub\V1\DeadLetterPolicy
A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. |
↳ retry_policy |
Google\Cloud\PubSub\V1\RetryPolicy
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. |
↳ detached |
bool
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. |
↳ enable_exactly_once_delivery |
bool
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of |
↳ topic_message_retention_duration |
Google\Protobuf\Duration
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last |
↳ state |
int
Output only. An output-only field indicating whether or not the subscription can receive messages. |
getName
Required. 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"
.
Returns | |
---|---|
Type | Description |
string |
setName
Required. 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"
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getTopic
Required. 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.
Returns | |
---|---|
Type | Description |
string |
setTopic
Required. 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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPushConfig
If push delivery is used with this subscription, this field is used to configure it.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\PushConfig|null |
hasPushConfig
clearPushConfig
setPushConfig
If push delivery is used with this subscription, this field is used to configure it.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\PushConfig
|
Returns | |
---|---|
Type | Description |
$this |
getBigqueryConfig
If delivery to BigQuery is used with this subscription, this field is used to configure it.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\BigQueryConfig|null |
hasBigqueryConfig
clearBigqueryConfig
setBigqueryConfig
If delivery to BigQuery is used with this subscription, this field is used to configure it.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\BigQueryConfig
|
Returns | |
---|---|
Type | Description |
$this |
getCloudStorageConfig
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\CloudStorageConfig|null |
hasCloudStorageConfig
clearCloudStorageConfig
setCloudStorageConfig
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\CloudStorageConfig
|
Returns | |
---|---|
Type | Description |
$this |
getAckDeadlineSeconds
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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
non-streaming pull or send the ack_id
in a
StreamingModifyAckDeadlineRequest
if using streaming 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.
Returns | |
---|---|
Type | Description |
int |
setAckDeadlineSeconds
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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
non-streaming pull or send the ack_id
in a
StreamingModifyAckDeadlineRequest
if using streaming 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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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. This must be true if you would like to Seek
to a timestamp in
the past to replay previously-acknowledged messages.
Returns | |
---|---|
Type | Description |
bool |
setRetainAckedMessages
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. This must be true if you would like to Seek
to a timestamp in
the past to replay previously-acknowledged messages.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasMessageRetentionDuration
clearMessageRetentionDuration
setMessageRetentionDuration
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getEnableMessageOrdering
If true, messages published with the same ordering_key
in PubsubMessage
will be delivered to the subscribers in the order in which they
are received by the Pub/Sub system. Otherwise, they may be delivered in
any order.
Returns | |
---|---|
Type | Description |
bool |
setEnableMessageOrdering
If true, messages published with the same ordering_key
in PubsubMessage
will be delivered to the subscribers in the order in which they
are received by the Pub/Sub system. Otherwise, they may be delivered in
any order.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getExpirationPolicy
A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If expiration_policy
is not set, a
default policy with ttl
of 31 days will be used. The minimum allowed
value for expiration_policy.ttl
is 1 day. If expiration_policy
is set,
but expiration_policy.ttl
is not set, the subscription never expires.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\ExpirationPolicy|null |
hasExpirationPolicy
clearExpirationPolicy
setExpirationPolicy
A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If expiration_policy
is not set, a
default policy with ttl
of 31 days will be used. The minimum allowed
value for expiration_policy.ttl
is 1 day. If expiration_policy
is set,
but expiration_policy.ttl
is not set, the subscription never expires.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\ExpirationPolicy
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessage
s whose attributes
field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
Returns | |
---|---|
Type | Description |
string |
setFilter
An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessage
s whose attributes
field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDeadLetterPolicy
A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\DeadLetterPolicy|null |
hasDeadLetterPolicy
clearDeadLetterPolicy
setDeadLetterPolicy
A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\DeadLetterPolicy
|
Returns | |
---|---|
Type | Description |
$this |
getRetryPolicy
A policy that specifies how Pub/Sub retries message delivery for this subscription.
If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\RetryPolicy|null |
hasRetryPolicy
clearRetryPolicy
setRetryPolicy
A policy that specifies how Pub/Sub retries message delivery for this subscription.
If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\PubSub\V1\RetryPolicy
|
Returns | |
---|---|
Type | Description |
$this |
getDetached
Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog. Pull
and StreamingPull
requests will return
FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
the endpoint will not be made.
Returns | |
---|---|
Type | Description |
bool |
setDetached
Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog. Pull
and StreamingPull
requests will return
FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
the endpoint will not be made.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getEnableExactlyOnceDelivery
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of message_id
on this subscription:
The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.
An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when
enable_exactly_once_delivery
is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_id
values.
Returns | |
---|---|
Type | Description |
bool |
setEnableExactlyOnceDelivery
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of message_id
on this subscription:
The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.
An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when
enable_exactly_once_delivery
is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_id
values.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getTopicMessageRetentionDuration
Output only. Indicates the minimum duration for which a message is retained
after it is published to the subscription's topic. If this field is set,
messages published to the subscription's topic in the last
topic_message_retention_duration
are always available to subscribers. See
the message_retention_duration
field in Topic
. This field is set only
in responses from the server; it is ignored if it is set in any requests.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasTopicMessageRetentionDuration
clearTopicMessageRetentionDuration
setTopicMessageRetentionDuration
Output only. Indicates the minimum duration for which a message is retained
after it is published to the subscription's topic. If this field is set,
messages published to the subscription's topic in the last
topic_message_retention_duration
are always available to subscribers. See
the message_retention_duration
field in Topic
. This field is set only
in responses from the server; it is ignored if it is set in any requests.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. An output-only field indicating whether or not the subscription can receive messages.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. An output-only field indicating whether or not the subscription can receive messages.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the subscription. It must have the format
|
topic |
string
Required. The name of the topic from which this subscription is receiving
messages. Format is |
pushConfig |
Google\Cloud\PubSub\V1\PushConfig
If push delivery is used with this subscription, this field is used to configure it. |
ackDeadlineSeconds |
int
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\PubSub\V1\Subscription |