@@ -42,9 +42,8 @@ service Publisher {
42
42
"https://www.googleapis.com/auth/cloud-platform,"
43
43
"https://www.googleapis.com/auth/pubsub" ;
44
44
45
- // Creates the given topic with the given name. See the
46
- // <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
47
- // resource name rules</a>.
45
+ // Creates the given topic with the given name. See the [resource name rules](
46
+ // https://cloud.google.com/pubsub/docs/admin#resource_names).
48
47
rpc CreateTopic (Topic ) returns (Topic ) {
49
48
option (google.api.http ) = {
50
49
put : "/v1/{name=projects/*/topics/*}"
@@ -98,11 +97,10 @@ service Publisher {
98
97
}
99
98
100
99
// Lists the names of the snapshots on this topic. Snapshots are used in
101
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
102
- // operations, which allow
103
- // you to manage message acknowledgments in bulk. That is, you can set the
104
- // acknowledgment state of messages in an existing subscription to the state
105
- // captured by a snapshot.
100
+ // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
101
+ // which allow you to manage message acknowledgments in bulk. That is, you can
102
+ // set the acknowledgment state of messages in an existing subscription to the
103
+ // state captured by a snapshot.
106
104
rpc ListTopicSnapshots (ListTopicSnapshotsRequest )
107
105
returns (ListTopicSnapshotsResponse ) {
108
106
option (google.api.http ) = {
@@ -161,8 +159,8 @@ message Topic {
161
159
// must not start with `"goog"`.
162
160
string name = 1 [(google.api.field_behavior ) = REQUIRED ];
163
161
164
- // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
165
- // managing labels</a> .
162
+ // See [ Creating and managing labels]
163
+ // (https://cloud.google.com/pubsub/docs/labels) .
166
164
map <string , string > labels = 2 ;
167
165
168
166
// Policy constraining the set of Google Cloud Platform regions where messages
@@ -180,11 +178,11 @@ message Topic {
180
178
// A message that is published by publishers and consumed by subscribers. The
181
179
// message must contain either a non-empty data field or at least one attribute.
182
180
// Note that client libraries represent this object differently
183
- // depending on the language. See the corresponding
184
- // <a href=" https://cloud.google.com/pubsub/docs/reference/libraries">client
185
- // library documentation</a> for more information. See
186
- // <a href=" https://cloud.google.com/pubsub/quotas">Quotas and limits</a>
187
- // for more information about message limits.
181
+ // depending on the language. See the corresponding [client library
182
+ // documentation]( https://cloud.google.com/pubsub/docs/reference/libraries) for
183
+ // more information. See [quotas and limits]
184
+ // ( https://cloud.google.com/pubsub/quotas) for more information about message
185
+ // limits.
188
186
message PubsubMessage {
189
187
// The message data field. If this field is empty, the message must contain
190
188
// at least one attribute.
@@ -212,9 +210,6 @@ message PubsubMessage {
212
210
// delivered to subscribers in the order in which they are received by the
213
211
// Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
214
212
// must specify the same `ordering_key` value.
215
- // <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
216
- // API might be changed in backward-incompatible ways and is not recommended
217
- // for production use. It is not subject to any SLA or deprecation policy.
218
213
string ordering_key = 5 ;
219
214
}
220
215
@@ -388,19 +383,17 @@ service Subscriber {
388
383
"https://www.googleapis.com/auth/cloud-platform,"
389
384
"https://www.googleapis.com/auth/pubsub" ;
390
385
391
- // Creates a subscription to a given topic. See the
392
- // <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
393
- // resource name rules</a>.
386
+ // Creates a subscription to a given topic. See the [resource name rules]
387
+ // (https://cloud.google.com/pubsub/docs/admin#resource_names).
394
388
// If the subscription already exists, returns `ALREADY_EXISTS`.
395
389
// If the corresponding topic doesn't exist, returns `NOT_FOUND`.
396
390
//
397
391
// If the name is not provided in the request, the server will assign a random
398
392
// name for this subscription on the same project as the topic, conforming
399
- // to the
400
- // [resource name
401
- // format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
402
- // generated name is populated in the returned Subscription object. Note that
403
- // for REST API requests, you must specify a name in the request.
393
+ // to the [resource name format]
394
+ // (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
395
+ // name is populated in the returned Subscription object. Note that for REST
396
+ // API requests, you must specify a name in the request.
404
397
rpc CreateSubscription (Subscription ) returns (Subscription ) {
405
398
option (google.api.http ) = {
406
399
put : "/v1/{name=projects/*/subscriptions/*}"
@@ -528,12 +521,11 @@ service Subscriber {
528
521
option (google.api.method_signature ) = "snapshot" ;
529
522
}
530
523
531
- // Lists the existing snapshots. Snapshots are used in
532
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
533
- // operations, which allow
534
- // you to manage message acknowledgments in bulk. That is, you can set the
535
- // acknowledgment state of messages in an existing subscription to the state
536
- // captured by a snapshot.
524
+ // Lists the existing snapshots. Snapshots are used in [Seek](
525
+ // https://cloud.google.com/pubsub/docs/replay-overview) operations, which
526
+ // allow you to manage message acknowledgments in bulk. That is, you can set
527
+ // the acknowledgment state of messages in an existing subscription to the
528
+ // state captured by a snapshot.
537
529
rpc ListSnapshots (ListSnapshotsRequest ) returns (ListSnapshotsResponse ) {
538
530
option (google.api.http ) = {
539
531
get : "/v1/{project=projects/*}/snapshots"
@@ -542,21 +534,19 @@ service Subscriber {
542
534
}
543
535
544
536
// Creates a snapshot from the requested subscription. Snapshots are used in
545
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
546
- // operations, which allow
547
- // you to manage message acknowledgments in bulk. That is, you can set the
548
- // acknowledgment state of messages in an existing subscription to the state
549
- // captured by a snapshot.
550
- // <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`.
537
+ // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
538
+ // which allow you to manage message acknowledgments in bulk. That is, you can
539
+ // set the acknowledgment state of messages in an existing subscription to the
540
+ // state captured by a snapshot.
541
+ // If the snapshot already exists, returns `ALREADY_EXISTS`.
551
542
// If the requested subscription doesn't exist, returns `NOT_FOUND`.
552
543
// If the backlog in the subscription is too old -- and the resulting snapshot
553
544
// would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
554
545
// See also the `Snapshot.expire_time` field. If the name is not provided in
555
546
// the request, the server will assign a random
556
547
// name for this snapshot on the same project as the subscription, conforming
557
- // to the
558
- // [resource name
559
- // format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
548
+ // to the [resource name format]
549
+ // (https://cloud.google.com/pubsub/docs/admin#resource_names). The
560
550
// generated name is populated in the returned Snapshot object. Note that for
561
551
// REST API requests, you must specify a name in the request.
562
552
rpc CreateSnapshot (CreateSnapshotRequest ) returns (Snapshot ) {
@@ -580,12 +570,11 @@ service Subscriber {
580
570
};
581
571
}
582
572
583
- // Removes an existing snapshot. Snapshots are used in
584
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
585
- // operations, which allow
586
- // you to manage message acknowledgments in bulk. That is, you can set the
587
- // acknowledgment state of messages in an existing subscription to the state
588
- // captured by a snapshot.<br><br>
573
+ // Removes an existing snapshot. Snapshots are used in [Seek]
574
+ // (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
575
+ // allow you to manage message acknowledgments in bulk. That is, you can set
576
+ // the acknowledgment state of messages in an existing subscription to the
577
+ // state captured by a snapshot.
589
578
// When the snapshot is deleted, all messages retained in the snapshot
590
579
// are immediately dropped. After a snapshot is deleted, a new one may be
591
580
// created with the same name, but the new one has no association with the old
@@ -598,13 +587,12 @@ service Subscriber {
598
587
}
599
588
600
589
// Seeks an existing subscription to a point in time or to a given snapshot,
601
- // whichever is provided in the request. Snapshots are used in
602
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
603
- // operations, which allow
604
- // you to manage message acknowledgments in bulk. That is, you can set the
605
- // acknowledgment state of messages in an existing subscription to the state
606
- // captured by a snapshot. Note that both the subscription and the snapshot
607
- // must be on the same topic.
590
+ // whichever is provided in the request. Snapshots are used in [Seek](
591
+ // https://cloud.google.com/pubsub/docs/replay-overview) operations, which
592
+ // allow you to manage message acknowledgments in bulk. That is, you can set
593
+ // the acknowledgment state of messages in an existing subscription to the
594
+ // state captured by a snapshot. Note that both the subscription and the
595
+ // snapshot must be on the same topic.
608
596
rpc Seek (SeekRequest ) returns (SeekResponse ) {
609
597
option (google.api.http ) = {
610
598
post : "/v1/{subscription=projects/*/subscriptions/*}:seek"
@@ -666,10 +654,8 @@ message Subscription {
666
654
// Indicates whether to retain acknowledged messages. If true, then
667
655
// messages are not expunged from the subscription's backlog, even if they are
668
656
// acknowledged, until they fall out of the `message_retention_duration`
669
- // window. This must be true if you would like to
670
- // <a
671
- // href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
672
- // Seek to a timestamp</a>.
657
+ // window. This must be true if you would like to [Seek to a timestamp]
658
+ // (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time).
673
659
bool retain_acked_messages = 7 ;
674
660
675
661
// How long to retain unacknowledged messages in the subscription's backlog,
@@ -688,9 +674,6 @@ message Subscription {
688
674
// will be delivered to the subscribers in the order in which they
689
675
// are received by the Pub/Sub system. Otherwise, they may be delivered in
690
676
// any order.
691
- // <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
692
- // API might be changed in backward-incompatible ways and is not recommended
693
- // for production use. It is not subject to any SLA or deprecation policy.
694
677
bool enable_message_ordering = 10 ;
695
678
696
679
// A policy that specifies the conditions for this subscription's expiration.
@@ -1186,11 +1169,10 @@ message UpdateSnapshotRequest {
1186
1169
}
1187
1170
1188
1171
// A snapshot resource. Snapshots are used in
1189
- // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
1190
- // operations, which allow
1191
- // you to manage message acknowledgments in bulk. That is, you can set the
1192
- // acknowledgment state of messages in an existing subscription to the state
1193
- // captured by a snapshot.
1172
+ // [Seek](https://cloud.google.com/pubsub/docs/replay-overview)
1173
+ // operations, which allow you to manage message acknowledgments in bulk. That
1174
+ // is, you can set the acknowledgment state of messages in an existing
1175
+ // subscription to the state captured by a snapshot.
1194
1176
message Snapshot {
1195
1177
option (google.api.resource ) = {
1196
1178
type : "pubsub.googleapis.com/Snapshot"
@@ -1217,8 +1199,8 @@ message Snapshot {
1217
1199
// snapshot that would expire in less than 1 hour after creation.
1218
1200
google.protobuf.Timestamp expire_time = 3 ;
1219
1201
1220
- // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
1221
- // managing labels</a> .
1202
+ // See [ Creating and managing labels]
1203
+ // (https://cloud.google.com/pubsub/docs/labels) .
1222
1204
map <string , string > labels = 4 ;
1223
1205
}
1224
1206
0 commit comments