Skip to content

Commit

Permalink
docs: modified some descriptions (#1773)
Browse files Browse the repository at this point in the history
* docs: modified some descriptions

PiperOrigin-RevId: 573936401

Source-Link: googleapis/googleapis@c1f0134

Source-Link: https://github.com/googleapis/googleapis-gen/commit/a063e1be04179c7386317bb395dea10eb38229b2
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTA2M2UxYmUwNDE3OWM3Mzg2MzE3YmIzOTVkZWExMGViMzgyMjliMiJ9

* 🦉 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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Oct 19, 2023
1 parent d2d8bb0 commit 17bd055
Show file tree
Hide file tree
Showing 11 changed files with 219 additions and 201 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ public PublisherStub getStub() {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -228,7 +228,7 @@ public final Topic createTopic(TopicName name) {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -288,7 +288,7 @@ public final Topic createTopic(ProjectTopicName name) {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -323,7 +323,7 @@ public final Topic createTopic(Topic request) {
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ public interface AsyncService {
*
* <pre>
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* </pre>
*/
default void createTopic(
Expand Down Expand Up @@ -640,7 +640,7 @@ protected PublisherStub build(io.grpc.Channel channel, io.grpc.CallOptions callO
*
* <pre>
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* </pre>
*/
public void createTopic(
Expand Down Expand Up @@ -816,7 +816,7 @@ protected PublisherBlockingStub build(
*
* <pre>
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* </pre>
*/
public com.google.pubsub.v1.Topic createTopic(com.google.pubsub.v1.Topic request) {
Expand Down Expand Up @@ -963,7 +963,7 @@ protected PublisherFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
*
* <pre>
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.pubsub.v1.Topic>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -742,15 +742,15 @@ public interface AsyncService {
*
* <pre>
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
*/
default void createSubscription(
Expand Down Expand Up @@ -962,7 +962,7 @@ default void listSnapshots(
* 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
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
Expand Down Expand Up @@ -1075,15 +1075,15 @@ protected SubscriberStub build(io.grpc.Channel channel, io.grpc.CallOptions call
*
* <pre>
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
*/
public void createSubscription(
Expand Down Expand Up @@ -1316,7 +1316,7 @@ public void listSnapshots(
* 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
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
Expand Down Expand Up @@ -1421,15 +1421,15 @@ protected SubscriberBlockingStub build(
*
* <pre>
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
*/
public com.google.pubsub.v1.Subscription createSubscription(
Expand Down Expand Up @@ -1609,7 +1609,7 @@ public com.google.pubsub.v1.ListSnapshotsResponse listSnapshots(
* 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
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
Expand Down Expand Up @@ -1702,15 +1702,15 @@ protected SubscriberFutureStub build(io.grpc.Channel channel, io.grpc.CallOption
*
* <pre>
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.pubsub.v1.Subscription>
Expand Down Expand Up @@ -1894,7 +1894,7 @@ protected SubscriberFutureStub build(io.grpc.Channel channel, io.grpc.CallOption
* 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
* (https://cloud.google.com/pubsub/docs/pubsub-basics#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.
* </pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ protected com.google.protobuf.MapField internalGetMapField(int number) {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down Expand Up @@ -116,8 +116,8 @@ public java.lang.String getName() {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down Expand Up @@ -746,8 +746,8 @@ public Builder mergeFrom(
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down Expand Up @@ -775,8 +775,8 @@ public java.lang.String getName() {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down Expand Up @@ -804,8 +804,8 @@ public com.google.protobuf.ByteString getNameBytes() {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand All @@ -832,8 +832,8 @@ public Builder setName(java.lang.String value) {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand All @@ -856,8 +856,8 @@ public Builder clearName() {
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public interface CreateSnapshotRequestOrBuilder
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand All @@ -50,8 +50,8 @@ public interface CreateSnapshotRequestOrBuilder
* 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 [resource name
* rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
* is `projects/{project}/snapshots/{snap}`.
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* </pre>
*
* <code>
Expand Down
Loading

0 comments on commit 17bd055

Please sign in to comment.