Subscription class Null safety
A subscription resource.
If none of push_config
or bigquery_config
is set, then the subscriber
will pull and ack messages using API methods. At most one of these fields
may be set.
Constructors
-
Subscription({int? ackDeadlineSeconds, BigQueryConfig? bigqueryConfig, DeadLetterPolicy? deadLetterPolicy, bool? detached, bool? enableExactlyOnceDelivery, bool? enableMessageOrdering, ExpirationPolicy? expirationPolicy, String? filter, Map<
String, String> ? labels, String? messageRetentionDuration, String? name, PushConfig? pushConfig, bool? retainAckedMessages, RetryPolicy? retryPolicy, String? state, String? topic, String? topicMessageRetentionDuration}) - Subscription.fromJson(Map json_)
Properties
- 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.
read / write
- bigqueryConfig ↔ BigQueryConfig?
-
If delivery to BigQuery is used with this subscription, this field is used
to configure it.
read / write
- deadLetterPolicy ↔ DeadLetterPolicy?
-
A policy that specifies the conditions for dead lettering messages in this
subscription.
read / write
- detached ↔ bool?
-
Indicates whether the subscription is detached from its topic.
read / write
- enableExactlyOnceDelivery ↔ bool?
-
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.read / write - enableMessageOrdering ↔ bool?
-
If true, messages published with the same
ordering_key
inPubsubMessage
will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.read / write - expirationPolicy ↔ ExpirationPolicy?
-
A policy that specifies the conditions for this subscription's expiration.
read / write
- filter ↔ String?
-
An expression written in the Pub/Sub
filter language.
read / write
- hashCode → int
-
The hash code for this object.
read-onlyinherited
-
labels
↔ Map<
String, String> ? -
See
Creating and managing labels.
read / write
- messageRetentionDuration ↔ String?
-
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
read / write
- name ↔ String?
-
The name of the subscription.
read / write
- pushConfig ↔ PushConfig?
-
If push delivery is used with this subscription, this field is used to
configure it.
read / write
- retainAckedMessages ↔ bool?
-
Indicates whether to retain acknowledged messages.
read / write
- retryPolicy ↔ RetryPolicy?
-
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- state ↔ String?
-
An output-only field indicating whether or not the subscription can
receive messages.
read / write
- topic ↔ String?
-
The name of the topic from which this subscription is receiving messages.
read / write
- topicMessageRetentionDuration ↔ String?
-
Indicates the minimum duration for which a message is retained after it is
published to the subscription's topic.
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited