Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::Subscription.
A subscription resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ack_deadline_seconds
def ack_deadline_seconds() -> ::Integer-
(::Integer) — 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
ModifyAckDeadlinewith the correspondingack_idif using non-streaming pull or send theack_idin aStreamingModifyAckDeadlineRequestif 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.
#ack_deadline_seconds=
def ack_deadline_seconds=(value) -> ::Integer-
value (::Integer) — 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
ModifyAckDeadlinewith the correspondingack_idif using non-streaming pull or send theack_idin aStreamingModifyAckDeadlineRequestif 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.
-
(::Integer) — 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
ModifyAckDeadlinewith the correspondingack_idif using non-streaming pull or send theack_idin aStreamingModifyAckDeadlineRequestif 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.
#bigquery_config
def bigquery_config() -> ::Google::Cloud::PubSub::V1::BigQueryConfig-
(::Google::Cloud::PubSub::V1::BigQueryConfig) — If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
#bigquery_config=
def bigquery_config=(value) -> ::Google::Cloud::PubSub::V1::BigQueryConfig-
value (::Google::Cloud::PubSub::V1::BigQueryConfig) — If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
-
(::Google::Cloud::PubSub::V1::BigQueryConfig) — If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
#dead_letter_policy
def dead_letter_policy() -> ::Google::Cloud::PubSub::V1::DeadLetterPolicy-
(::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.
#dead_letter_policy=
def dead_letter_policy=(value) -> ::Google::Cloud::PubSub::V1::DeadLetterPolicy-
value (::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.
-
(::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.
#detached
def detached() -> ::Boolean-
(::Boolean) — Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
#detached=
def detached=(value) -> ::Boolean-
value (::Boolean) — Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
-
(::Boolean) — Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog.
PullandStreamingPullrequests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
#enable_exactly_once_delivery
def enable_exactly_once_delivery() -> ::Boolean-
(::Boolean) — If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of
message_idon 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
#enable_exactly_once_delivery=
def enable_exactly_once_delivery=(value) -> ::Boolean-
value (::Boolean) — If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of
message_idon 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
-
(::Boolean) — If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of
message_idon 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
#enable_message_ordering
def enable_message_ordering() -> ::Boolean-
(::Boolean) — If true, messages published with the same
ordering_keyinPubsubMessagewill 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.
#enable_message_ordering=
def enable_message_ordering=(value) -> ::Boolean-
value (::Boolean) — If true, messages published with the same
ordering_keyinPubsubMessagewill 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.
-
(::Boolean) — If true, messages published with the same
ordering_keyinPubsubMessagewill 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.
#expiration_policy
def expiration_policy() -> ::Google::Cloud::PubSub::V1::ExpirationPolicy-
(::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
expiration_policyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpiration_policy.ttlis 1 day.
#expiration_policy=
def expiration_policy=(value) -> ::Google::Cloud::PubSub::V1::ExpirationPolicy-
value (::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
expiration_policyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpiration_policy.ttlis 1 day.
-
(::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
expiration_policyis not set, a default policy withttlof 31 days will be used. The minimum allowed value forexpiration_policy.ttlis 1 day.
#filter
def filter() -> ::String-
(::String) — An expression written in the Pub/Sub filter
language. If non-empty,
then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
#filter=
def filter=(value) -> ::String-
value (::String) — An expression written in the Pub/Sub filter
language. If non-empty,
then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
-
(::String) — An expression written in the Pub/Sub filter
language. If non-empty,
then only
PubsubMessages whoseattributesfield matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}- (::Google::Protobuf::Map{::String => ::String}) — See Creating and managing labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}- value (::Google::Protobuf::Map{::String => ::String}) — See Creating and managing labels.
- (::Google::Protobuf::Map{::String => ::String}) — See Creating and managing labels.
#message_retention_duration
def message_retention_duration() -> ::Google::Protobuf::Duration-
(::Google::Protobuf::Duration) — How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
If
retain_acked_messagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time aSeekcan be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
#message_retention_duration=
def message_retention_duration=(value) -> ::Google::Protobuf::Duration-
value (::Google::Protobuf::Duration) — How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
If
retain_acked_messagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time aSeekcan be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
-
(::Google::Protobuf::Duration) — How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
If
retain_acked_messagesis true, then this also configures the retention of acknowledged messages, and thus configures how far back in time aSeekcan be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
#name
def name() -> ::String-
(::String) — 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".
#name=
def name=(value) -> ::String-
value (::String) — 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".
-
(::String) — 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".
#push_config
def push_config() -> ::Google::Cloud::PubSub::V1::PushConfig-
(::Google::Cloud::PubSub::V1::PushConfig) — If push delivery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
#push_config=
def push_config=(value) -> ::Google::Cloud::PubSub::V1::PushConfig-
value (::Google::Cloud::PubSub::V1::PushConfig) — If push delivery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
-
(::Google::Cloud::PubSub::V1::PushConfig) — If push delivery is used with this subscription, this field is
used to configure it. Either
pushConfigorbigQueryConfigcan be set, but not both. If both are empty, then the subscriber will pull and ack messages using API methods.
#retain_acked_messages
def retain_acked_messages() -> ::Boolean-
(::Boolean) — 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_durationwindow. This must be true if you would like toSeekto a timestamp in the past to replay previously-acknowledged messages.
#retain_acked_messages=
def retain_acked_messages=(value) -> ::Boolean-
value (::Boolean) — 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_durationwindow. This must be true if you would like toSeekto a timestamp in the past to replay previously-acknowledged messages.
-
(::Boolean) — 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_durationwindow. This must be true if you would like toSeekto a timestamp in the past to replay previously-acknowledged messages.
#retry_policy
def retry_policy() -> ::Google::Cloud::PubSub::V1::RetryPolicy-
(::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.
#retry_policy=
def retry_policy=(value) -> ::Google::Cloud::PubSub::V1::RetryPolicy-
value (::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.
-
(::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.
#state
def state() -> ::Google::Cloud::PubSub::V1::Subscription::State- (::Google::Cloud::PubSub::V1::Subscription::State) — Output only. An output-only field indicating whether or not the subscription can receive messages.
#topic
def topic() -> ::String-
(::String) — 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.
#topic=
def topic=(value) -> ::String-
value (::String) — 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.
-
(::String) — 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.
#topic_message_retention_duration
def topic_message_retention_duration() -> ::Google::Protobuf::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
topic_message_retention_durationare always available to subscribers. See themessage_retention_durationfield inTopic. This field is set only in responses from the server; it is ignored if it is set in any requests.