Skip to content

Commit bb626b1

Browse files
Google APIscopybara-github
authored andcommitted
docs: Replacing HTML code with Markdown
docs: Fix PullResponse description docs: Fix Pull description PiperOrigin-RevId: 509846267
1 parent 19473b4 commit bb626b1

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

google/pubsub/v1/pubsub.proto

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -517,9 +517,7 @@ service Subscriber {
517517
option (google.api.method_signature) = "subscription,ack_ids";
518518
}
519519

520-
// Pulls messages from the server. The server may return `UNAVAILABLE` if
521-
// there are too many concurrent pull requests pending for the given
522-
// subscription.
520+
// Pulls messages from the server.
523521
rpc Pull(PullRequest) returns (PullResponse) {
524522
option (google.api.http) = {
525523
post: "/v1/{subscription=projects/*/subscriptions/*}:pull"
@@ -556,10 +554,10 @@ service Subscriber {
556554
}
557555

558556
// Gets the configuration details of a snapshot. Snapshots are used in
559-
// <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
560-
// operations, which allow you to manage message acknowledgments in bulk. That
561-
// is, you can set the acknowledgment state of messages in an existing
562-
// subscription to the state captured by a snapshot.
557+
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
558+
// which allow you to manage message acknowledgments in bulk. That is, you can
559+
// set the acknowledgment state of messages in an existing subscription to the
560+
// state captured by a snapshot.
563561
rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot) {
564562
option (google.api.http) = {
565563
get: "/v1/{snapshot=projects/*/snapshots/*}"
@@ -604,11 +602,10 @@ service Subscriber {
604602
}
605603

606604
// Updates an existing snapshot. Snapshots are used in
607-
// <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
608-
// operations, which allow
609-
// you to manage message acknowledgments in bulk. That is, you can set the
610-
// acknowledgment state of messages in an existing subscription to the state
611-
// captured by a snapshot.
605+
// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
606+
// which allow you to manage message acknowledgments in bulk. That is, you can
607+
// set the acknowledgment state of messages in an existing subscription to the
608+
// state captured by a snapshot.
612609
rpc UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot) {
613610
option (google.api.http) = {
614611
patch: "/v1/{snapshot.name=projects/*/snapshots/*}"
@@ -700,7 +697,7 @@ message Subscription {
700697
// The approximate amount of time (on a best-effort basis) Pub/Sub waits for
701698
// the subscriber to acknowledge receipt before resending the message. In the
702699
// interval after the message is delivered and before it is acknowledged, it
703-
// is considered to be <i>outstanding</i>. During that time period, the
700+
// is considered to be _outstanding_. During that time period, the
704701
// message will not be redelivered (on a best-effort basis).
705702
//
706703
// For pull subscriptions, this value is used as the initial value for the ack
@@ -735,8 +732,8 @@ message Subscription {
735732
// minutes.
736733
google.protobuf.Duration message_retention_duration = 8;
737734

738-
// See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
739-
// managing labels</a>.
735+
// See [Creating and managing
736+
// labels](https://cloud.google.com/pubsub/docs/labels).
740737
map<string, string> labels = 9;
741738

742739
// If true, messages published with the same `ordering_key` in `PubsubMessage`
@@ -925,7 +922,7 @@ message PushConfig {
925922
// * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
926923
//
927924
// For example:
928-
// <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
925+
// `attributes { "x-goog-version": "v1" }`
929926
map<string, string> attributes = 2;
930927

931928
// An authentication method used by push endpoints to verify the source of
@@ -1130,7 +1127,8 @@ message PullRequest {
11301127
// Response for the `Pull` method.
11311128
message PullResponse {
11321129
// Received Pub/Sub messages. The list will be empty if there are no more
1133-
// messages available in the backlog. For JSON, the response can be entirely
1130+
// messages available in the backlog, or if no messages could be returned
1131+
// before the request timeout. For JSON, the response can be entirely
11341132
// empty. The Pub/Sub system may return fewer than the `maxMessages` requested
11351133
// even if there are more messages available in the backlog.
11361134
repeated ReceivedMessage received_messages = 1;
@@ -1316,9 +1314,9 @@ message CreateSnapshotRequest {
13161314
// Required. User-provided name for this snapshot. If the name is not provided
13171315
// in the request, the server will assign a random name for this snapshot on
13181316
// the same project as the subscription. Note that for REST API requests, you
1319-
// must specify a name. See the <a
1320-
// href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
1321-
// name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
1317+
// must specify a name. See the [resource name
1318+
// rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
1319+
// is `projects/{project}/snapshots/{snap}`.
13221320
string name = 1 [
13231321
(google.api.field_behavior) = REQUIRED,
13241322
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
@@ -1340,8 +1338,8 @@ message CreateSnapshotRequest {
13401338
}
13411339
];
13421340

1343-
// See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
1344-
// managing labels</a>.
1341+
// See [Creating and managing
1342+
// labels](https://cloud.google.com/pubsub/docs/labels).
13451343
map<string, string> labels = 3;
13461344
}
13471345

0 commit comments

Comments
 (0)