diff --git a/google/pubsub/v1/pubsub.proto b/google/pubsub/v1/pubsub.proto
index dc915144..909863eb 100644
--- a/google/pubsub/v1/pubsub.proto
+++ b/google/pubsub/v1/pubsub.proto
@@ -42,9 +42,8 @@ service Publisher {
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/pubsub";
- // Creates the given topic with the given name. See the
- //
- // resource name rules.
+ // Creates the given topic with the given name. See the [resource name rules](
+ // https://cloud.google.com/pubsub/docs/admin#resource_names).
rpc CreateTopic(Topic) returns (Topic) {
option (google.api.http) = {
put: "/v1/{name=projects/*/topics/*}"
@@ -98,11 +97,10 @@ service Publisher {
}
// Lists the names of the snapshots on this topic. Snapshots are used in
- // Seek
- // 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.
+ // [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.
rpc ListTopicSnapshots(ListTopicSnapshotsRequest)
returns (ListTopicSnapshotsResponse) {
option (google.api.http) = {
@@ -161,8 +159,8 @@ message Topic {
// must not start with `"goog"`.
string name = 1 [(google.api.field_behavior) = REQUIRED];
- // See Creating and
- // managing labels.
+ // See [Creating and managing labels]
+ // (https://cloud.google.com/pubsub/docs/labels).
map labels = 2;
// Policy constraining the set of Google Cloud Platform regions where messages
@@ -180,11 +178,11 @@ message Topic {
// 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 for more information. See
-// Quotas and limits
-// for more information about message limits.
+// 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.
message PubsubMessage {
// The message data field. If this field is empty, the message must contain
// at least one attribute.
@@ -212,9 +210,6 @@ message PubsubMessage {
// delivered to subscribers in the order in which they are received by the
// Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
// must specify the same `ordering_key` value.
- // EXPERIMENTAL: 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.
string ordering_key = 5;
}
@@ -388,19 +383,17 @@ service Subscriber {
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/pubsub";
- // Creates a subscription to a given topic. See the
- //
- // resource name rules.
+ // Creates a subscription to a given topic. See the [resource name rules]
+ // (https://cloud.google.com/pubsub/docs/admin#resource_names).
// 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.
+ // 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 CreateSubscription(Subscription) returns (Subscription) {
option (google.api.http) = {
put: "/v1/{name=projects/*/subscriptions/*}"
@@ -528,12 +521,11 @@ service Subscriber {
option (google.api.method_signature) = "snapshot";
}
- // Lists the existing snapshots. Snapshots are used in
- // Seek
- // 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.
+ // Lists the existing snapshots. 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.
rpc ListSnapshots(ListSnapshotsRequest) returns (ListSnapshotsResponse) {
option (google.api.http) = {
get: "/v1/{project=projects/*}/snapshots"
@@ -542,21 +534,19 @@ service Subscriber {
}
// Creates a snapshot from the requested subscription. Snapshots are used in
- // Seek
- // 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.
- //
If the snapshot already exists, returns `ALREADY_EXISTS`.
+ // [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.
+ // 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
+ // 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.
rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot) {
@@ -580,12 +570,11 @@ service Subscriber {
};
}
- // Removes an existing snapshot. Snapshots are used in
- // Seek
- // 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.
+ // Removes an existing snapshot. 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.
// 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
@@ -598,13 +587,12 @@ service Subscriber {
}
// Seeks an existing subscription to a point in time or to a given snapshot,
- // whichever is provided in the request. Snapshots are used in
- // Seek
- // 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.
+ // whichever is provided in the request. 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. Note that both the subscription and the
+ // snapshot must be on the same topic.
rpc Seek(SeekRequest) returns (SeekResponse) {
option (google.api.http) = {
post: "/v1/{subscription=projects/*/subscriptions/*}:seek"
@@ -666,10 +654,8 @@ message Subscription {
// 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.
+ // 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).
bool retain_acked_messages = 7;
// How long to retain unacknowledged messages in the subscription's backlog,
@@ -688,9 +674,6 @@ message Subscription {
// 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.
- // EXPERIMENTAL: 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.
bool enable_message_ordering = 10;
// A policy that specifies the conditions for this subscription's expiration.
@@ -1186,11 +1169,10 @@ message UpdateSnapshotRequest {
}
// A snapshot resource. Snapshots are used in
-// Seek
-// 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.
+// [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.
message Snapshot {
option (google.api.resource) = {
type: "pubsub.googleapis.com/Snapshot"
@@ -1217,8 +1199,8 @@ message Snapshot {
// snapshot that would expire in less than 1 hour after creation.
google.protobuf.Timestamp expire_time = 3;
- // See Creating and
- // managing labels.
+ // See [Creating and managing labels]
+ // (https://cloud.google.com/pubsub/docs/labels).
map labels = 4;
}