google_api_pub_sub v0.12.0 GoogleApi.PubSub.V1.Model.Subscription View Source
A subscription resource.
Attributes
ackDeadlineSeconds
(type:integer()
, default:nil
) - 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 correspondingack_id
if using non-streaming pull or send theack_id
in aStreamingModifyAckDeadlineRequest
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.
expirationPolicy
(type:GoogleApi.PubSub.V1.Model.ExpirationPolicy.t
, default:nil
) - 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. Ifexpiration_policy
is not set, a default policy withttl
of 31 days will be used. The minimum allowed value forexpiration_policy.ttl
is 1 day.labels
(type:map()
, default:nil
) - See Creating and managing labels.messageRetentionDuration
(type:String.t
, default:nil
) - How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. Ifretain_acked_messages
is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time aSeek
can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.name
(type:String.t
, default:nil
) - 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"
.pushConfig
(type:GoogleApi.PubSub.V1.Model.PushConfig.t
, default:nil
) - If push delivery is used with this subscription, this field is used to configure it. An emptypushConfig
signifies that the subscriber will pull and ack messages using API methods.retainAckedMessages
(type:boolean()
, default:nil
) - 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 themessage_retention_duration
window. This must be true if you would like to a%0Ahref=%22https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time%22 Seek to a timestamp.topic
(type:String.t
, default:nil
) - The name of the topic from which this subscription is receiving messages. Format isprojects/{project}/topics/{topic}
. The value of this field will be_deleted-topic_
if the topic has been deleted.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Sourcet() :: %GoogleApi.PubSub.V1.Model.Subscription{ ackDeadlineSeconds: integer(), expirationPolicy: GoogleApi.PubSub.V1.Model.ExpirationPolicy.t(), labels: map(), messageRetentionDuration: String.t(), name: String.t(), pushConfig: GoogleApi.PubSub.V1.Model.PushConfig.t(), retainAckedMessages: boolean(), topic: String.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.