Skip to content

Commit 63c147a

Browse files
docs(regen): switch to proto annotations (#90)
1 parent f38b712 commit 63c147a

File tree

62 files changed

+1929
-1194
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1929
-1194
lines changed

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

+78-70
Large diffs are not rendered by default.

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

+24-14
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ public PublisherStub getStub() {
190190
* }
191191
* </code></pre>
192192
*
193-
* @param name The name of the topic. It must have the format
193+
* @param name Required. The name of the topic. It must have the format
194194
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only
195195
* letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`),
196196
* tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
@@ -217,7 +217,7 @@ public final Topic createTopic(ProjectTopicName name) {
217217
* }
218218
* </code></pre>
219219
*
220-
* @param name The name of the topic. It must have the format
220+
* @param name Required. The name of the topic. It must have the format
221221
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only
222222
* letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`),
223223
* tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
@@ -345,9 +345,9 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
345345
* }
346346
* </code></pre>
347347
*
348-
* @param topic The messages in the request will be published on this topic. Format is
348+
* @param topic Required. The messages in the request will be published on this topic. Format is
349349
* `projects/{project}/topics/{topic}`.
350-
* @param messages The messages to publish.
350+
* @param messages Required. The messages to publish.
351351
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
352352
*/
353353
/* package-private */ final PublishResponse publish(
@@ -378,9 +378,9 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
378378
* }
379379
* </code></pre>
380380
*
381-
* @param topic The messages in the request will be published on this topic. Format is
381+
* @param topic Required. The messages in the request will be published on this topic. Format is
382382
* `projects/{project}/topics/{topic}`.
383-
* @param messages The messages to publish.
383+
* @param messages Required. The messages to publish.
384384
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
385385
*/
386386
/* package-private */ final PublishResponse publish(String topic, List<PubsubMessage> messages) {
@@ -459,7 +459,8 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
459459
* }
460460
* </code></pre>
461461
*
462-
* @param topic The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
462+
* @param topic Required. The name of the topic to get. Format is
463+
* `projects/{project}/topics/{topic}`.
463464
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
464465
*/
465466
public final Topic getTopic(ProjectTopicName topic) {
@@ -481,7 +482,8 @@ public final Topic getTopic(ProjectTopicName topic) {
481482
* }
482483
* </code></pre>
483484
*
484-
* @param topic The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
485+
* @param topic Required. The name of the topic to get. Format is
486+
* `projects/{project}/topics/{topic}`.
485487
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
486488
*/
487489
public final Topic getTopic(String topic) {
@@ -549,7 +551,7 @@ public final UnaryCallable<GetTopicRequest, Topic> getTopicCallable() {
549551
* }
550552
* </code></pre>
551553
*
552-
* @param project The name of the project in which to list topics. Format is
554+
* @param project Required. The name of the project in which to list topics. Format is
553555
* `projects/{project-id}`.
554556
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
555557
*/
@@ -576,7 +578,7 @@ public final ListTopicsPagedResponse listTopics(ProjectName project) {
576578
* }
577579
* </code></pre>
578580
*
579-
* @param project The name of the project in which to list topics. Format is
581+
* @param project Required. The name of the project in which to list topics. Format is
580582
* `projects/{project-id}`.
581583
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
582584
*/
@@ -680,7 +682,7 @@ public final UnaryCallable<ListTopicsRequest, ListTopicsResponse> listTopicsCall
680682
* }
681683
* </code></pre>
682684
*
683-
* @param topic The name of the topic that subscriptions are attached to. Format is
685+
* @param topic Required. The name of the topic that subscriptions are attached to. Format is
684686
* `projects/{project}/topics/{topic}`.
685687
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
686688
*/
@@ -707,7 +709,7 @@ public final ListTopicSubscriptionsPagedResponse listTopicSubscriptions(ProjectT
707709
* }
708710
* </code></pre>
709711
*
710-
* @param topic The name of the topic that subscriptions are attached to. Format is
712+
* @param topic Required. The name of the topic that subscriptions are attached to. Format is
711713
* `projects/{project}/topics/{topic}`.
712714
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
713715
*/
@@ -816,7 +818,8 @@ public final ListTopicSubscriptionsPagedResponse listTopicSubscriptions(
816818
* }
817819
* </code></pre>
818820
*
819-
* @param topic Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
821+
* @param topic Required. Name of the topic to delete. Format is
822+
* `projects/{project}/topics/{topic}`.
820823
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
821824
*/
822825
public final void deleteTopic(ProjectTopicName topic) {
@@ -841,7 +844,8 @@ public final void deleteTopic(ProjectTopicName topic) {
841844
* }
842845
* </code></pre>
843846
*
844-
* @param topic Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
847+
* @param topic Required. Name of the topic to delete. Format is
848+
* `projects/{project}/topics/{topic}`.
845849
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
846850
*/
847851
public final void deleteTopic(String topic) {
@@ -904,6 +908,8 @@ public final UnaryCallable<DeleteTopicRequest, Empty> deleteTopicCallable() {
904908
/**
905909
* Sets the access control policy on the specified resource. Replaces any existing policy.
906910
*
911+
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
912+
*
907913
* <p>Sample code:
908914
*
909915
* <pre><code>
@@ -931,6 +937,8 @@ public final Policy setIamPolicy(String resource, Policy policy) {
931937
/**
932938
* Sets the access control policy on the specified resource. Replaces any existing policy.
933939
*
940+
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
941+
*
934942
* <p>Sample code:
935943
*
936944
* <pre><code>
@@ -956,6 +964,8 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) {
956964
/**
957965
* Sets the access control policy on the specified resource. Replaces any existing policy.
958966
*
967+
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
968+
*
959969
* <p>Sample code:
960970
*
961971
* <pre><code>

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/package-info.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*/
1616

1717
/**
18-
* A client to Google Cloud Pub/Sub API.
18+
* A client to Cloud Pub/Sub API.
1919
*
2020
* <p>The interfaces provided are listed below, along with usage samples.
2121
*

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcPublisherCallableFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
// AUTO-GENERATED DOCUMENTATION AND CLASS
3838
/**
39-
* gRPC callable factory implementation for Google Cloud Pub/Sub API.
39+
* gRPC callable factory implementation for Cloud Pub/Sub API.
4040
*
4141
* <p>This class is for advanced usage.
4242
*/

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcPublisherStub.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252

5353
// AUTO-GENERATED DOCUMENTATION AND CLASS
5454
/**
55-
* gRPC stub implementation for Google Cloud Pub/Sub API.
55+
* gRPC stub implementation for Cloud Pub/Sub API.
5656
*
5757
* <p>This class is for advanced usage and reflects the underlying API directly.
5858
*/

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcSubscriberCallableFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
// AUTO-GENERATED DOCUMENTATION AND CLASS
3838
/**
39-
* gRPC callable factory implementation for Google Cloud Pub/Sub API.
39+
* gRPC callable factory implementation for Cloud Pub/Sub API.
4040
*
4141
* <p>This class is for advanced usage.
4242
*/

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcSubscriberStub.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464

6565
// AUTO-GENERATED DOCUMENTATION AND CLASS
6666
/**
67-
* gRPC stub implementation for Google Cloud Pub/Sub API.
67+
* gRPC stub implementation for Cloud Pub/Sub API.
6868
*
6969
* <p>This class is for advanced usage and reflects the underlying API directly.
7070
*/

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/PublisherStub.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
// AUTO-GENERATED DOCUMENTATION AND CLASS
4343
/**
44-
* Base stub class for Google Cloud Pub/Sub API.
44+
* Base stub class for Cloud Pub/Sub API.
4545
*
4646
* <p>This class is for advanced usage and reflects the underlying API directly.
4747
*/

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/SubscriberStub.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353

5454
// AUTO-GENERATED DOCUMENTATION AND CLASS
5555
/**
56-
* Base stub class for Google Cloud Pub/Sub API.
56+
* Base stub class for Cloud Pub/Sub API.
5757
*
5858
* <p>This class is for advanced usage and reflects the underlying API directly.
5959
*/

0 commit comments

Comments
 (0)