Skip to content

Commit 8e92ac0

Browse files
docs: modified some descriptions (#1842)
* docs: modified some descriptions PiperOrigin-RevId: 573936401 Source-Link: googleapis/googleapis@c1f0134 Source-Link: googleapis/googleapis-gen@a063e1b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTA2M2UxYmUwNDE3OWM3Mzg2MzE3YmIzOTVkZWExMGViMzgyMjliMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 4567d85 commit 8e92ac0

File tree

3 files changed

+22
-21
lines changed

3 files changed

+22
-21
lines changed

protos/google/pubsub/v1/pubsub.proto

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ service Publisher {
4444
"https://www.googleapis.com/auth/pubsub";
4545

4646
// Creates the given topic with the given name. See the [resource name rules]
47-
// (https://cloud.google.com/pubsub/docs/admin#resource_names).
47+
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
4848
rpc CreateTopic(Topic) returns (Topic) {
4949
option (google.api.http) = {
5050
put: "/v1/{name=projects/*/topics/*}"
@@ -137,11 +137,12 @@ service Publisher {
137137

138138
// A policy constraining the storage of messages published to the topic.
139139
message MessageStoragePolicy {
140-
// A list of IDs of GCP regions where messages that are published to the topic
141-
// may be persisted in storage. Messages published by publishers running in
142-
// non-allowed GCP regions (or running outside of GCP altogether) will be
143-
// routed for storage in one of the allowed regions. An empty list means that
144-
// no regions are allowed, and is not a valid configuration.
140+
// A list of IDs of Google Cloud regions where messages that are published
141+
// to the topic may be persisted in storage. Messages published by publishers
142+
// running in non-allowed Google Cloud regions (or running outside of Google
143+
// Cloud altogether) are routed for storage in one of the allowed regions.
144+
// An empty list means that no regions are allowed, and is not a valid
145+
// configuration.
145146
repeated string allowed_persistence_regions = 1;
146147
}
147148

@@ -430,16 +431,16 @@ service Subscriber {
430431
"https://www.googleapis.com/auth/pubsub";
431432

432433
// Creates a subscription to a given topic. See the [resource name rules]
433-
// (https://cloud.google.com/pubsub/docs/admin#resource_names).
434+
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
434435
// If the subscription already exists, returns `ALREADY_EXISTS`.
435436
// If the corresponding topic doesn't exist, returns `NOT_FOUND`.
436437
//
437438
// If the name is not provided in the request, the server will assign a random
438439
// name for this subscription on the same project as the topic, conforming
439440
// to the [resource name format]
440-
// (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
441-
// name is populated in the returned Subscription object. Note that for REST
442-
// API requests, you must specify a name in the request.
441+
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
442+
// generated name is populated in the returned Subscription object. Note that
443+
// for REST API requests, you must specify a name in the request.
443444
rpc CreateSubscription(Subscription) returns (Subscription) {
444445
option (google.api.http) = {
445446
put: "/v1/{name=projects/*/subscriptions/*}"
@@ -592,7 +593,7 @@ service Subscriber {
592593
// the request, the server will assign a random
593594
// name for this snapshot on the same project as the subscription, conforming
594595
// to the [resource name format]
595-
// (https://cloud.google.com/pubsub/docs/admin#resource_names). The
596+
// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
596597
// generated name is populated in the returned Snapshot object. Note that for
597598
// REST API requests, you must specify a name in the request.
598599
rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot) {
@@ -1429,8 +1430,8 @@ message CreateSnapshotRequest {
14291430
// in the request, the server will assign a random name for this snapshot on
14301431
// the same project as the subscription. Note that for REST API requests, you
14311432
// must specify a name. See the [resource name
1432-
// rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
1433-
// is `projects/{project}/snapshots/{snap}`.
1433+
// rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
1434+
// Format is `projects/{project}/snapshots/{snap}`.
14341435
string name = 1 [
14351436
(google.api.field_behavior) = REQUIRED,
14361437
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }

src/v1/publisher_client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ export class PublisherClient {
386386
// -------------------
387387
/**
388388
* Creates the given topic with the given name. See the [resource name rules]
389-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
389+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
390390
*
391391
* @param {Object} request
392392
* The request object that will be sent.

src/v1/subscriber_client.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -394,16 +394,16 @@ export class SubscriberClient {
394394
// -------------------
395395
/**
396396
* Creates a subscription to a given topic. See the [resource name rules]
397-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
397+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
398398
* If the subscription already exists, returns `ALREADY_EXISTS`.
399399
* If the corresponding topic doesn't exist, returns `NOT_FOUND`.
400400
*
401401
* If the name is not provided in the request, the server will assign a random
402402
* name for this subscription on the same project as the topic, conforming
403403
* to the [resource name format]
404-
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
405-
* name is populated in the returned Subscription object. Note that for REST
406-
* API requests, you must specify a name in the request.
404+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
405+
* generated name is populated in the returned Subscription object. Note that
406+
* for REST API requests, you must specify a name in the request.
407407
*
408408
* @param {Object} request
409409
* The request object that will be sent.
@@ -1324,7 +1324,7 @@ export class SubscriberClient {
13241324
* the request, the server will assign a random
13251325
* name for this snapshot on the same project as the subscription, conforming
13261326
* to the [resource name format]
1327-
* (https://cloud.google.com/pubsub/docs/admin#resource_names). The
1327+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
13281328
* generated name is populated in the returned Snapshot object. Note that for
13291329
* REST API requests, you must specify a name in the request.
13301330
*
@@ -1335,8 +1335,8 @@ export class SubscriberClient {
13351335
* in the request, the server will assign a random name for this snapshot on
13361336
* the same project as the subscription. Note that for REST API requests, you
13371337
* must specify a name. See the [resource name
1338-
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
1339-
* is `projects/{project}/snapshots/{snap}`.
1338+
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
1339+
* Format is `projects/{project}/snapshots/{snap}`.
13401340
* @param {string} request.subscription
13411341
* Required. The subscription whose backlog the snapshot retains.
13421342
* Specifically, the created snapshot is guaranteed to retain:

0 commit comments

Comments
 (0)