pubsub
Request for the Acknowledge method.
Request for the CreateSnapshot method.
Request for the CreateSnapshot method.
Required. User-provided name for this snapshot. If the name is not provided
in the request, the server will assign a random name for this snapshot on
the same project as the subscription. Note that for REST API requests, you
must specify a name. See the <a
href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
name rules</a>. Format is projects/{project}/snapshots/{snap}.
Required. The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of the
CreateSnapshot request; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format is projects/{project}/subscriptions/{sub}.
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
Dead lettering is done on a best effort basis.
Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.
If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
The name of the topic to which dead letter messages should be published.
Format is projects/{project}/topics/{topic}.The Cloud Pub/Sub service
account associated with the enclosing subscription's parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
permission to Publish() to this topic.
The operation will fail if the topic does not exist.
Users should ensure that there is a subscription attached to this topic
since messages published to a topic with no subscriptions are lost.
The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
Request for the DeleteSnapshot method.
Request for the DeleteSnapshot method.
Required. The name of the snapshot to delete.
Format is projects/{project}/snapshots/{snap}.
Request for the DeleteSubscription method.
Request for the DeleteSubscription method.
Required. The subscription to delete.
Format is projects/{project}/subscriptions/{sub}.
Request for the DeleteTopic method.
Request for the DeleteTopic method.
Required. Name of the topic to delete.
Format is projects/{project}/topics/{topic}.
Request for the DetachSubscription method.
Request for the DetachSubscription method.
Required. The subscription to detach.
Format is projects/{project}/subscriptions/{subscription}.
Response for the DetachSubscription method.
Response for the DetachSubscription method. Reserved for future use.
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
Specifies the "time-to-live" duration for an associated resource. The
resource expires if it is not active for a period of ttl. The definition
of "activity" depends on the type of the associated resource. The minimum
and maximum allowed values for ttl depend on the type of the associated
resource, as well. If ttl is not set, the associated resource never
expires.
Request for the GetSnapshot method.
Request for the GetSnapshot method.
Required. The name of the snapshot to get.
Format is projects/{project}/snapshots/{snap}.
Request for the GetSubscription method.
Request for the GetSubscription method.
Required. The name of the subscription to get.
Format is projects/{project}/subscriptions/{sub}.
Request for the GetTopic method.
Request for the GetTopic method.
Required. The name of the topic to get.
Format is projects/{project}/topics/{topic}.
Request for the ListSnapshots method.
Request for the ListSnapshots method.
Required. The name of the project in which to list snapshots.
Format is projects/{project-id}.
Maximum number of snapshots to return.
The value returned by the last ListSnapshotsResponse; indicates that this
is a continuation of a prior ListSnapshots call, and that the system
should return the next page of data.
Response for the ListSnapshots method.
Response for the ListSnapshots method.
The resulting snapshots.
If not empty, indicates that there may be more snapshot that match the
request; this value should be passed in a new ListSnapshotsRequest.
Request for the ListSubscriptions method.
Request for the ListSubscriptions method.
Required. The name of the project in which to list subscriptions.
Format is projects/{project-id}.
Maximum number of subscriptions to return.
The value returned by the last ListSubscriptionsResponse; indicates that
this is a continuation of a prior ListSubscriptions call, and that the
system should return the next page of data.
Response for the ListSubscriptions method.
Response for the ListSubscriptions method.
The subscriptions that match the request.
If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListSubscriptionsRequest to get more subscriptions.
Request for the ListTopicSnapshots method.
Request for the ListTopicSnapshots method.
Required. The name of the topic that snapshots are attached to.
Format is projects/{project}/topics/{topic}.
Maximum number of snapshot names to return.
The value returned by the last ListTopicSnapshotsResponse; indicates
that this is a continuation of a prior ListTopicSnapshots call, and
that the system should return the next page of data.
Response for the ListTopicSnapshots method.
Response for the ListTopicSnapshots method.
The names of the snapshots that match the request.
If not empty, indicates that there may be more snapshots that match
the request; this value should be passed in a new
ListTopicSnapshotsRequest to get more snapshots.
Request for the ListTopicSubscriptions method.
Request for the ListTopicSubscriptions method.
Required. The name of the topic that subscriptions are attached to.
Format is projects/{project}/topics/{topic}.
Maximum number of subscription names to return.
The value returned by the last ListTopicSubscriptionsResponse; indicates
that this is a continuation of a prior ListTopicSubscriptions call, and
that the system should return the next page of data.
Response for the ListTopicSubscriptions method.
Response for the ListTopicSubscriptions method.
The names of subscriptions attached to the topic specified in the request.
If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListTopicSubscriptionsRequest to get more subscriptions.
Request for the ListTopics method.
Request for the ListTopics method.
Required. The name of the project in which to list topics.
Format is projects/{project-id}.
Maximum number of topics to return.
The value returned by the last ListTopicsResponse; indicates that this is
a continuation of a prior ListTopics call, and that the system should
return the next page of data.
Response for the ListTopics method.
Response for the ListTopics method.
The resulting topics.
If not empty, indicates that there may be more topics that match the
request; this value should be passed in a new ListTopicsRequest.
A policy constraining the storage of messages published to the topic.
A policy constraining the storage of messages published to the topic.
A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
Request for the ModifyAckDeadline method.
Request for the ModifyAckDeadline method.
Required. The name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
Required. List of acknowledgment IDs.
Required. The new ack deadline with respect to the time this request was
sent to the Pub/Sub system. For example, if the value is 10, the new ack
deadline will expire 10 seconds after the ModifyAckDeadline call was
made. Specifying zero might immediately make the message available for
delivery to another subscriber client. This typically results in an
increase in the rate of message redeliveries (that is, duplicates).
The minimum deadline you can specify is 0 seconds.
The maximum deadline you can specify is 600 seconds (10 minutes).
Request for the ModifyPushConfig method.
Request for the ModifyPushConfig method.
Required. The name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
Required. The push configuration for future deliveries.
An empty pushConfig indicates that the Pub/Sub system should
stop pushing messages from the given subscription and allow
messages to be pulled and acknowledged - effectively pausing
the subscription if Pull or StreamingPull is not called.
Request for the Publish method.
Request for the Publish method.
Required. The messages in the request will be published on this topic.
Format is projects/{project}/topics/{topic}.
Required. The messages to publish.
Response for the Publish method.
Response for the Publish method.
The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
A message that is published by publishers and consumed by subscribers.
A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.
The message data field. If this field is empty, the message must contain at least one attribute.
Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
ID of this message, assigned by the server when the message is published.
Guaranteed to be unique within the topic. This value may be read by a
subscriber that receives a PubsubMessage via a Pull call or a push
delivery. It must not be populated by the publisher in a Publish call.
The time at which the message was published, populated by the server when
it receives the Publish call. It must not be populated by the
publisher in a Publish call.
If non-empty, identifies related messages for which publish order should be
respected. If a Subscription has enable_message_ordering set to true,
messages published with the same non-empty ordering_key value will be
delivered to subscribers in the order in which they are received by the
Pub/Sub system. All PubsubMessages published in a given PublishRequest
must specify the same ordering_key value.
Request for the Pull method.
Request for the Pull method.
Required. The subscription from which messages should be pulled.
Format is projects/{project}/subscriptions/{sub}.
Optional. If this field set to true, the system will respond immediately
even if it there are no messages available to return in the Pull
response. Otherwise, the system may wait (for a bounded amount of time)
until at least one message is available, rather than returning no messages.
Warning: setting this field to true is discouraged because it adversely
impacts the performance of Pull operations. We recommend that users do
not set this field.
Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
Response for the Pull method.
Response for the Pull method.
Received Pub/Sub messages. The list will be empty if there are no more
messages available in the backlog. For JSON, the response can be entirely
empty. The Pub/Sub system may return fewer than the maxMessages requested
even if there are more messages available in the backlog.
Configuration for a push delivery endpoint.
Configuration for a push delivery endpoint.
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
* v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
* v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.
For example:
<pre><code>attributes { "x-goog-version": "v1" } </code></pre>
A message and its corresponding acknowledgment ID.
A message and its corresponding acknowledgment ID.
This ID can be used to acknowledge the received message.
The message.
The approximate number of times that Cloud Pub/Sub has attempted to deliver
the associated message to a subscriber.
More precisely, this is 1 + (number of NACKs) +
(number of ack_deadline exceeds) for this message.
A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
exceeds event is whenever a message is not acknowledged within
ack_deadline. Note that ack_deadline is initially
Subscription.ackDeadlineSeconds, but may get extended automatically by
the client library.
Upon the first delivery of a given message, delivery_attempt will have a
value of 1. The value is calculated at best effort and is approximate.
If a DeadLetterPolicy is not set on the subscription, this will be 0.
A policy that specifies how Cloud Pub/Sub retries message delivery.
A policy that specifies how Cloud Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
Request for the Seek method.
Request for the Seek method.
Required. The subscription to affect.
Response for the Seek method (this response is empty).
Response for the Seek method (this response is empty).
A snapshot resource.
A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
The name of the snapshot.
The name of the topic from which this snapshot is retaining messages.
The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is 7 days - (age of oldest unacked message in the subscription).
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Request for the StreamingPull streaming RPC method.
Request for the StreamingPull streaming RPC method. This request is used to
establish the initial stream as well as to stream acknowledgements and ack
deadline modifications from the client to the server.
Required. The subscription for which to initialize the new stream. This
must be provided in the first request on the stream, and must not be set in
subsequent requests from client to server.
Format is projects/{project}/subscriptions/{sub}.
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream). If an ack ID has expired,
the corresponding message may be redelivered later. Acknowledging a message
more than once will not result in an error. If the acknowledgement ID is
malformed, the stream will be aborted with status INVALID_ARGUMENT.
The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids. The size of this list must be the same as the
size of modify_deadline_ack_ids. If it differs the stream will be aborted
with INVALID_ARGUMENT. Each element in this list is applied to the
element in the same position in modify_deadline_ack_ids. The new ack
deadline is with respect to the time this request was sent to the Pub/Sub
system. Must be >= 0. For example, if the value is 10, the new ack deadline
will expire 10 seconds after this request is received. If the value is 0,
the message is immediately made available for another streaming or
non-streaming pull request. If the value is < 0 (an error), the stream will
be aborted with status INVALID_ARGUMENT.
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in modify_deadline_seconds. This field can be used
to indicate that more time is needed to process a message by the
subscriber, or to make the message available for redelivery if the
processing was interrupted.
Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.
Flow control settings for the maximum number of outstanding messages. When
there are max_outstanding_messages or more currently sent to the
streaming pull client that have not yet been acked or nacked, the server
stops sending more messages. The sending of messages resumes once the
number of outstanding messages is less than this value. If the value is
<= 0, there is no limit to the number of outstanding messages. This
property can only be set on the initial StreamingPullRequest. If it is set
on a subsequent request, the stream will be aborted with status
INVALID_ARGUMENT.
Flow control settings for the maximum number of outstanding bytes. When
there are max_outstanding_bytes or more worth of messages currently sent
to the streaming pull client that have not yet been acked or nacked, the
server will stop sending more messages. The sending of messages resumes
once the number of outstanding bytes is less than this value. If the value
is <= 0, there is no limit to the number of outstanding bytes. This
property can only be set on the initial StreamingPullRequest. If it is set
on a subsequent request, the stream will be aborted with status
INVALID_ARGUMENT.
Response for the StreamingPull method.
Response for the StreamingPull method. This response is used to stream
messages from the server to the client.
Received Pub/Sub messages. This will not be empty.
A subscription resource.
A subscription resource.
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".
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.
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.
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 <i>outstanding</i>. 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.
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]
(https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time).
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.
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
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.
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.
An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
then only PubsubMessages whose attributes field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
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.
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.
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.
A topic resource.
A topic resource.
Required. The name of the topic. It must have the format
"projects/{project}/topics/{topic}". {topic} 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".
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
The resource name of the Cloud KMS CryptoKey to be used to protect access
to messages published on this topic.
The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
Request for the UpdateSnapshot method.
Request for the UpdateSnapshot method.
Required. The updated snapshot object.
Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
Request for the UpdateSubscription method.
Request for the UpdateSubscription method.
Required. The updated subscription object.
Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.
Request for the UpdateTopic method.
Request for the UpdateTopic method.
Required. The updated topic object.
Required. Indicates which fields in the provided topic to update. Must be
specified and non-empty. Note that if update_mask contains
"message_storage_policy" but the message_storage_policy is not set in
the topic provided above, then the updated value is determined by the
policy configured at the project or organization level.
Request for the Acknowledge method.
Required. The subscription whose message is being acknowledged. Format is
projects/{project}/subscriptions/{sub}.Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the
Pullresponse. Must not be empty.