Skip to content

Commit

Permalink
docs: Replacing HTML code with Markdown
Browse files Browse the repository at this point in the history
docs: Fix PullResponse description
docs: Fix Pull description

PiperOrigin-RevId: 509846267
  • Loading branch information
Google APIs authored and Copybara-Service committed Feb 15, 2023
1 parent 19473b4 commit bb626b1
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions google/pubsub/v1/pubsub.proto
Expand Up @@ -517,9 +517,7 @@ service Subscriber {
option (google.api.method_signature) = "subscription,ack_ids";
}

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

// Gets 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.
// [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 GetSnapshot(GetSnapshotRequest) returns (Snapshot) {
option (google.api.http) = {
get: "/v1/{snapshot=projects/*/snapshots/*}"
Expand Down Expand Up @@ -604,11 +602,10 @@ service Subscriber {
}

// Updates 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.
// [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 UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot) {
option (google.api.http) = {
patch: "/v1/{snapshot.name=projects/*/snapshots/*}"
Expand Down Expand Up @@ -700,7 +697,7 @@ message Subscription {
// 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
// is considered to be _outstanding_. 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
Expand Down Expand Up @@ -735,8 +732,8 @@ message Subscription {
// minutes.
google.protobuf.Duration message_retention_duration = 8;

// See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
// managing labels</a>.
// See [Creating and managing
// labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;

// If true, messages published with the same `ordering_key` in `PubsubMessage`
Expand Down Expand Up @@ -925,7 +922,7 @@ message PushConfig {
// * `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>
// `attributes { "x-goog-version": "v1" }`
map<string, string> attributes = 2;

// An authentication method used by push endpoints to verify the source of
Expand Down Expand Up @@ -1130,7 +1127,8 @@ message PullRequest {
// Response for the `Pull` method.
message PullResponse {
// 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
// messages available in the backlog, or if no messages could be returned
// before the request timeout. 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.
repeated ReceivedMessage received_messages = 1;
Expand Down Expand Up @@ -1316,9 +1314,9 @@ message CreateSnapshotRequest {
// 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}`.
// must specify a name. See the [resource name
// rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
// is `projects/{project}/snapshots/{snap}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
Expand All @@ -1340,8 +1338,8 @@ message CreateSnapshotRequest {
}
];

// See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
// managing labels</a>.
// See [Creating and managing
// labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
}

Expand Down

0 comments on commit bb626b1

Please sign in to comment.