package google.pubsub.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Publisher
pubsub.proto:38The service that an application uses to manipulate topics, and to send messages to a topic.
rpc CreateTopic (, )
pubsub.proto:47Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>.
rpc UpdateTopic (, )
pubsub.proto:56Updates an existing topic. Note that certain properties of a topic are not modifiable.
message
pubsub.proto:199Request for the UpdateTopic method.
optional topic = 1
The updated topic object.
optional update_mask = 2
Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above.
rpc Publish (, )
pubsub.proto:65Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.
message
pubsub.proto:212Request for the Publish method.
string topic = 1
The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`.
repeated messages = 2
The messages to publish.
message
pubsub.proto:222Response for the `Publish` method.
repeated string message_ids = 1
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.
rpc GetTopic (, )
pubsub.proto:73Gets the configuration of a topic.
message
pubsub.proto:192Request for the GetTopic method.
string topic = 1
The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
rpc ListTopics (, )
pubsub.proto:80Lists matching topics.
message
pubsub.proto:230Request for the `ListTopics` method.
string project = 1
The name of the project in which to list topics. Format is `projects/{project-id}`.
int32 page_size = 2
Maximum number of topics to return.
string page_token = 3
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.
message
pubsub.proto:245Response for the `ListTopics` method.
repeated topics = 1
The resulting topics.
string next_page_token = 2
If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
Lists the names of the subscriptions on this topic.
message
pubsub.proto:255Request for the `ListTopicSubscriptions` method.
string topic = 1
The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.
int32 page_size = 2
Maximum number of subscription names to return.
string page_token = 3
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.
message
pubsub.proto:270Response for the `ListTopicSubscriptions` method.
repeated string subscriptions = 1
The names of the subscriptions that match the request.
string next_page_token = 2
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.
rpc ListTopicSnapshots (, )
pubsub.proto:100Lists the names of the snapshots on this topic. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
message
pubsub.proto:281Request for the `ListTopicSnapshots` method.
string topic = 1
The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.
int32 page_size = 2
Maximum number of snapshot names to return.
string page_token = 3
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.
message
pubsub.proto:296Response for the `ListTopicSnapshots` method.
repeated string snapshots = 1
The names of the snapshots that match the request.
string next_page_token = 2
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.
rpc DeleteTopic (, )
pubsub.proto:112Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
message
pubsub.proto:307Request for the `DeleteTopic` method.
string topic = 1
Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
service Subscriber
pubsub.proto:316The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the `Pull` method or by establishing a bi-directional stream using the `StreamingPull` method.
rpc CreateSubscription (, )
pubsub.proto:335Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
rpc GetSubscription (, )
pubsub.proto:343Gets the configuration details of a subscription.
message
pubsub.proto:761Request for the GetSubscription method.
string subscription = 1
The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.
rpc UpdateSubscription (, )
pubsub.proto:351Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
message
pubsub.proto:768Request for the UpdateSubscription method.
optional subscription = 1
The updated subscription object.
optional update_mask = 2
Indicates which fields in the provided subscription to update. Must be specified and non-empty.
rpc ListSubscriptions (, )
pubsub.proto:359Lists matching subscriptions.
message
pubsub.proto:778Request for the `ListSubscriptions` method.
string project = 1
The name of the project in which to list subscriptions. Format is `projects/{project-id}`.
int32 page_size = 2
Maximum number of subscriptions to return.
string page_token = 3
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.
message
pubsub.proto:793Response for the `ListSubscriptions` method.
repeated subscriptions = 1
The subscriptions that match the request.
string next_page_token = 2
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.
rpc DeleteSubscription (, )
pubsub.proto:371Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
message
pubsub.proto:804Request for the DeleteSubscription method.
string subscription = 1
The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.
rpc ModifyAckDeadline (, )
pubsub.proto:383Modifies the ack deadline for a specific message. This method is useful 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. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.
message
pubsub.proto:853Request for the ModifyAckDeadline method.
string subscription = 1
The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
repeated string ack_ids = 4
List of acknowledgment IDs.
int32 ack_deadline_seconds = 3
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).
rpc Acknowledge (, )
pubsub.proto:398Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
message
pubsub.proto:873Request for the Acknowledge method.
string subscription = 1
The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`.
repeated string ack_ids = 2
The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.
rpc Pull (, )
pubsub.proto:408Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
message
pubsub.proto:826Request for the `Pull` method.
string subscription = 1
The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
bool return_immediately = 2
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.
int32 max_messages = 3
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.
message
pubsub.proto:844Response for the `Pull` method.
repeated received_messages = 1
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.
rpc StreamingPull (stream , stream )
pubsub.proto:422Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status `UNAVAILABLE` to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.
message
pubsub.proto:886Request 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.
string subscription = 1
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}`.
repeated string ack_ids = 2
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`.
repeated int32 modify_deadline_seconds = 3
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`.
repeated string modify_deadline_ack_ids = 4
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.
int32 stream_ack_deadline_seconds = 5
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).
message
pubsub.proto:929Response for the `StreamingPull` method. This response is used to stream messages from the server to the client.
repeated received_messages = 1
Received Pub/Sub messages. This will not be empty.
rpc ModifyPushConfig (, )
pubsub.proto:431Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
message
pubsub.proto:811Request for the ModifyPushConfig method.
string subscription = 1
The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
optional push_config = 2
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.
rpc GetSnapshot (, )
pubsub.proto:444Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
message
pubsub.proto:1002Request for the GetSnapshot method.
string snapshot = 1
The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`.
rpc ListSnapshots (, )
pubsub.proto:456Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
message
pubsub.proto:1009Request for the `ListSnapshots` method.
string project = 1
The name of the project in which to list snapshots. Format is `projects/{project-id}`.
int32 page_size = 2
Maximum number of snapshots to return.
string page_token = 3
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.
message
pubsub.proto:1024Response for the `ListSnapshots` method.
repeated snapshots = 1
The resulting snapshots.
string next_page_token = 2
If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`.
rpc CreateSnapshot (, )
pubsub.proto:480Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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. <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. 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, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.
message
pubsub.proto:935Request for the `CreateSnapshot` method.
string name = 1
Optional 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}`.
string subscription = 2
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}`.
map<string, string> labels = 3
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
rpc UpdateSnapshot (, )
pubsub.proto:493Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
message
pubsub.proto:962Request for the UpdateSnapshot method.
optional snapshot = 1
The updated snapshot object.
optional update_mask = 2
Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
rpc DeleteSnapshot (, )
pubsub.proto:510Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.<br><br> When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.
message
pubsub.proto:1034Request for the `DeleteSnapshot` method.
string snapshot = 1
The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.
rpc Seek (, )
pubsub.proto:524Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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. Note that both the subscription and the snapshot must be on the same topic.
message
pubsub.proto:1041Request for the `Seek` method.
string subscription = 1
The subscription to affect.
oneof target
time = 2
The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.
string snapshot = 3
The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`.
message
pubsub.proto:1067Response for the `Seek` method (this response is empty).
(message has no fields)
message
pubsub.proto:632Dead 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.
Used in:
string dead_letter_topic = 1
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.
int32 max_delivery_attempts = 2
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.
message
pubsub.proto:662A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
Used in:
optional ttl = 1
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.
message
pubsub.proto:119Used in:
repeated string allowed_persistence_regions = 1
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.
message
pubsub.proto:162A 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 <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits.
Used in: ,
bytes data = 1
The message data field. If this field is empty, the message must contain at least one attribute.
map<string, string> attributes = 2
Optional attributes for this message.
string message_id = 3
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.
optional publish_time = 4
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.
string ordering_key = 5
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 `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
message
pubsub.proto:673Configuration for a push delivery endpoint.
Used in: ,
string push_endpoint = 1
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
map<string, string> attributes = 2
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>
oneof authentication_method
An authentication method used by push endpoints to verify the source of push requests. This can be used with push endpoints that are private by default to allow requests only from the Cloud Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push.
oidc_token = 3
If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
message
pubsub.proto:677Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).
Used in:
string service_account_email = 1
[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.
string audience = 2
Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
message
pubsub.proto:734A message and its corresponding acknowledgment ID.
Used in: ,
string ack_id = 1
This ID can be used to acknowledge the received message.
optional message = 2
The message.
int32 delivery_attempt = 3
Delivery attempt counter is 1 + (the sum of number of NACKs and 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. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
message
pubsub.proto:977A snapshot resource. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
Used as response type in: Subscriber.CreateSnapshot, Subscriber.GetSnapshot, Subscriber.UpdateSnapshot
Used as field type in: ,
string name = 1
The name of the snapshot.
string topic = 2
The name of the topic from which this snapshot is retaining messages.
optional expire_time = 3
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.
map<string, string> labels = 4
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
message
pubsub.proto:533A subscription resource.
Used as request type in: Subscriber.CreateSubscription
Used as response type in: Subscriber.CreateSubscription, Subscriber.GetSubscription, Subscriber.UpdateSubscription
Used as field type in: ,
string name = 1
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 topic = 2
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.
optional push_config = 4
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.
int32 ack_deadline_seconds = 5
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.
bool retain_acked_messages = 7
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 <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>.
optional message_retention_duration = 8
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.
map<string, string> labels = 9
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
bool enable_message_ordering = 10
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. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
optional expiration_policy = 11
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.
optional dead_letter_policy = 13
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. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
message
pubsub.proto:129A topic resource.
Used as request type in: Publisher.CreateTopic
Used as response type in: Publisher.CreateTopic, Publisher.GetTopic, Publisher.UpdateTopic
Used as field type in: ,
string name = 1
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"`.
map<string, string> labels = 2
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
optional message_storage_policy = 3
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.
string kms_key_name = 5
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/*`.