Skip to content

Commit 17bd055

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: modified some descriptions (#1773)
* 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 
1 parent d2d8bb0 commit 17bd055

File tree

11 files changed

+219
-201
lines changed

11 files changed

+219
-201
lines changed

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

‎google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/TopicAdminClient.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ public PublisherStub getStub() {
197197
// AUTO-GENERATED DOCUMENTATION AND METHOD.
198198
/**
199199
* Creates the given topic with the given name. See the [resource name rules]
200-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
200+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
201201
*
202202
*

Sample code:

203203
*
@@ -228,7 +228,7 @@ public final Topic createTopic(TopicName name) {
228228
// AUTO-GENERATED DOCUMENTATION AND METHOD.
229229
/**
230230
* Creates the given topic with the given name. See the [resource name rules]
231-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
231+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
232232
*
233233
*

Sample code:

234234
*
@@ -288,7 +288,7 @@ public final Topic createTopic(ProjectTopicName name) {
288288
// AUTO-GENERATED DOCUMENTATION AND METHOD.
289289
/**
290290
* Creates the given topic with the given name. See the [resource name rules]
291-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
291+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
292292
*
293293
*

Sample code:

294294
*
@@ -323,7 +323,7 @@ public final Topic createTopic(Topic request) {
323323
// AUTO-GENERATED DOCUMENTATION AND METHOD.
324324
/**
325325
* Creates the given topic with the given name. See the [resource name rules]
326-
* (https://cloud.google.com/pubsub/docs/admin#resource_names).
326+
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
327327
*
328328
*

Sample code:

329329
*

‎grpc-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/PublisherGrpc.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ public interface AsyncService {
465465
*
466466
* 
467467
     * Creates the given topic with the given name. See the [resource name rules]
468-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
468+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
469469
     * 
470470
     */
471471
    default void createTopic(
@@ -640,7 +640,7 @@ protected PublisherStub build(io.grpc.Channel channel, io.grpc.CallOptions callO
640640
     *
641641
     * 
642642
     * Creates the given topic with the given name. See the [resource name rules]
643-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
643+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
644644
     * 
645645
     */
646646
    public void createTopic(
@@ -816,7 +816,7 @@ protected PublisherBlockingStub build(
816816
     *
817817
     * 
818818
     * Creates the given topic with the given name. See the [resource name rules]
819-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
819+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
820820
     * 
821821
     */
822822
    public com.google.pubsub.v1.Topic createTopic(com.google.pubsub.v1.Topic request) {
@@ -963,7 +963,7 @@ protected PublisherFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
963963
     *
964964
     * 
965965
     * Creates the given topic with the given name. See the [resource name rules]
966-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
966+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
967967
     * 
968968
     */
969969
    public com.google.common.util.concurrent.ListenableFuture<com.google.pubsub.v1.Topic>
‎grpc-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/SubscriberGrpc.java
Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -742,15 +742,15 @@ public interface AsyncService {
742742
     *
743743
     * 
744744
     * Creates a subscription to a given topic. See the [resource name rules]
745-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
745+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
746746
     * If the subscription already exists, returns `ALREADY_EXISTS`.
747747
     * If the corresponding topic doesn't exist, returns `NOT_FOUND`.
748748
     * If the name is not provided in the request, the server will assign a random
749749
     * name for this subscription on the same project as the topic, conforming
750750
     * to the [resource name format]
751-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
752-
     * name is populated in the returned Subscription object. Note that for REST
753-
     * API requests, you must specify a name in the request.
751+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
752+
     * generated name is populated in the returned Subscription object. Note that
753+
     * for REST API requests, you must specify a name in the request.
754754
     * 
755755
     */
756756
    default void createSubscription(
@@ -962,7 +962,7 @@ default void listSnapshots(
962962
     * the request, the server will assign a random
963963
     * name for this snapshot on the same project as the subscription, conforming
964964
     * to the [resource name format]
965-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The
965+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
966966
     * generated name is populated in the returned Snapshot object. Note that for
967967
     * REST API requests, you must specify a name in the request.
968968
     * 
@@ -1075,15 +1075,15 @@ protected SubscriberStub build(io.grpc.Channel channel, io.grpc.CallOptions call
10751075
     *
10761076
     * 
10771077
     * Creates a subscription to a given topic. See the [resource name rules]
1078-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
1078+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
10791079
     * If the subscription already exists, returns `ALREADY_EXISTS`.
10801080
     * If the corresponding topic doesn't exist, returns `NOT_FOUND`.
10811081
     * If the name is not provided in the request, the server will assign a random
10821082
     * name for this subscription on the same project as the topic, conforming
10831083
     * to the [resource name format]
1084-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
1085-
     * name is populated in the returned Subscription object. Note that for REST
1086-
     * API requests, you must specify a name in the request.
1084+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
1085+
     * generated name is populated in the returned Subscription object. Note that
1086+
     * for REST API requests, you must specify a name in the request.
10871087
     * 
10881088
     */
10891089
    public void createSubscription(
@@ -1316,7 +1316,7 @@ public void listSnapshots(
13161316
     * the request, the server will assign a random
13171317
     * name for this snapshot on the same project as the subscription, conforming
13181318
     * to the [resource name format]
1319-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The
1319+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
13201320
     * generated name is populated in the returned Snapshot object. Note that for
13211321
     * REST API requests, you must specify a name in the request.
13221322
     * 
@@ -1421,15 +1421,15 @@ protected SubscriberBlockingStub build(
14211421
     *
14221422
     * 
14231423
     * Creates a subscription to a given topic. See the [resource name rules]
1424-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
1424+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
14251425
     * If the subscription already exists, returns `ALREADY_EXISTS`.
14261426
     * If the corresponding topic doesn't exist, returns `NOT_FOUND`.
14271427
     * If the name is not provided in the request, the server will assign a random
14281428
     * name for this subscription on the same project as the topic, conforming
14291429
     * to the [resource name format]
1430-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
1431-
     * name is populated in the returned Subscription object. Note that for REST
1432-
     * API requests, you must specify a name in the request.
1430+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
1431+
     * generated name is populated in the returned Subscription object. Note that
1432+
     * for REST API requests, you must specify a name in the request.
14331433
     * 
14341434
     */
14351435
    public com.google.pubsub.v1.Subscription createSubscription(
@@ -1609,7 +1609,7 @@ public com.google.pubsub.v1.ListSnapshotsResponse listSnapshots(
16091609
     * the request, the server will assign a random
16101610
     * name for this snapshot on the same project as the subscription, conforming
16111611
     * to the [resource name format]
1612-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The
1612+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
16131613
     * generated name is populated in the returned Snapshot object. Note that for
16141614
     * REST API requests, you must specify a name in the request.
16151615
     * 
@@ -1702,15 +1702,15 @@ protected SubscriberFutureStub build(io.grpc.Channel channel, io.grpc.CallOption
17021702
     *
17031703
     * 
17041704
     * Creates a subscription to a given topic. See the [resource name rules]
1705-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
1705+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
17061706
     * If the subscription already exists, returns `ALREADY_EXISTS`.
17071707
     * If the corresponding topic doesn't exist, returns `NOT_FOUND`.
17081708
     * If the name is not provided in the request, the server will assign a random
17091709
     * name for this subscription on the same project as the topic, conforming
17101710
     * to the [resource name format]
1711-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
1712-
     * name is populated in the returned Subscription object. Note that for REST
1713-
     * API requests, you must specify a name in the request.
1711+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
1712+
     * generated name is populated in the returned Subscription object. Note that
1713+
     * for REST API requests, you must specify a name in the request.
17141714
     * 
17151715
     */
17161716
    public com.google.common.util.concurrent.ListenableFuture<com.google.pubsub.v1.Subscription>
@@ -1894,7 +1894,7 @@ protected SubscriberFutureStub build(io.grpc.Channel channel, io.grpc.CallOption
18941894
     * the request, the server will assign a random
18951895
     * name for this snapshot on the same project as the subscription, conforming
18961896
     * to the [resource name format]
1897-
     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The
1897+
     * (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
18981898
     * generated name is populated in the returned Snapshot object. Note that for
18991899
     * REST API requests, you must specify a name in the request.
19001900
     * 
‎proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CreateSnapshotRequest.java
Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ protected com.google.protobuf.MapField internalGetMapField(int number) {
8686
   * in the request, the server will assign a random name for this snapshot on
8787
   * the same project as the subscription. Note that for REST API requests, you
8888
   * must specify a name.  See the [resource name
89-
   * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
90-
   * is `projects/{project}/snapshots/{snap}`.
89+
   * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
90+
   * Format is `projects/{project}/snapshots/{snap}`.
9191
   * 
9292
   *
9393
   * 
@@ -116,8 +116,8 @@ public java.lang.String getName() {
116116
   * in the request, the server will assign a random name for this snapshot on
117117
   * the same project as the subscription. Note that for REST API requests, you
118118
   * must specify a name.  See the [resource name
119-
   * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
120-
   * is `projects/{project}/snapshots/{snap}`.
119+
   * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
120+
   * Format is `projects/{project}/snapshots/{snap}`.
121121
   * 
122122
   *
123123
   * 
@@ -746,8 +746,8 @@ public Builder mergeFrom(
746746
     * in the request, the server will assign a random name for this snapshot on
747747
     * the same project as the subscription. Note that for REST API requests, you
748748
     * must specify a name.  See the [resource name
749-
     * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
750-
     * is `projects/{project}/snapshots/{snap}`.
749+
     * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
750+
     * Format is `projects/{project}/snapshots/{snap}`.
751751
     * 
752752
     *
753753
     * 
@@ -775,8 +775,8 @@ public java.lang.String getName() {
775775
     * in the request, the server will assign a random name for this snapshot on
776776
     * the same project as the subscription. Note that for REST API requests, you
777777
     * must specify a name.  See the [resource name
778-
     * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
779-
     * is `projects/{project}/snapshots/{snap}`.
778+
     * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
779+
     * Format is `projects/{project}/snapshots/{snap}`.
780780
     * 
781781
     *
782782
     * 
@@ -804,8 +804,8 @@ public com.google.protobuf.ByteString getNameBytes() {
804804
     * in the request, the server will assign a random name for this snapshot on
805805
     * the same project as the subscription. Note that for REST API requests, you
806806
     * must specify a name.  See the [resource name
807-
     * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
808-
     * is `projects/{project}/snapshots/{snap}`.
807+
     * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
808+
     * Format is `projects/{project}/snapshots/{snap}`.
809809
     * 
810810
     *
811811
     * 
@@ -832,8 +832,8 @@ public Builder setName(java.lang.String value) {
832832
     * in the request, the server will assign a random name for this snapshot on
833833
     * the same project as the subscription. Note that for REST API requests, you
834834
     * must specify a name.  See the [resource name
835-
     * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
836-
     * is `projects/{project}/snapshots/{snap}`.
835+
     * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
836+
     * Format is `projects/{project}/snapshots/{snap}`.
837837
     * 
838838
     *
839839
     * 
@@ -856,8 +856,8 @@ public Builder clearName() {
856856
     * in the request, the server will assign a random name for this snapshot on
857857
     * the same project as the subscription. Note that for REST API requests, you
858858
     * must specify a name.  See the [resource name
859-
     * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
860-
     * is `projects/{project}/snapshots/{snap}`.
859+
     * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
860+
     * Format is `projects/{project}/snapshots/{snap}`.
861861
     * 
862862
     *
863863
     * 
‎proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CreateSnapshotRequestOrBuilder.java
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ public interface CreateSnapshotRequestOrBuilder
3131
   * in the request, the server will assign a random name for this snapshot on
3232
   * the same project as the subscription. Note that for REST API requests, you
3333
   * must specify a name.  See the [resource name
34-
   * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
35-
   * is `projects/{project}/snapshots/{snap}`.
34+
   * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
35+
   * Format is `projects/{project}/snapshots/{snap}`.
3636
   * 
3737
   *
3838
   * 
@@ -50,8 +50,8 @@ public interface CreateSnapshotRequestOrBuilder
5050
   * in the request, the server will assign a random name for this snapshot on
5151
   * the same project as the subscription. Note that for REST API requests, you
5252
   * must specify a name.  See the [resource name
53-
   * rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
54-
   * is `projects/{project}/snapshots/{snap}`.
53+
   * rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
54+
   * Format is `projects/{project}/snapshots/{snap}`.
5555
   * 
5656
   *
5757
   * 
0 commit comments
Comments
 (0)