Skip to content

Commit

Permalink
docs(regen): switch to proto annotations (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation committed Feb 27, 2020
1 parent f38b712 commit 63c147a
Show file tree
Hide file tree
Showing 62 changed files with 1,929 additions and 1,194 deletions.

Large diffs are not rendered by default.

Expand Up @@ -190,7 +190,7 @@ public PublisherStub getStub() {
* }
* </code></pre>
*
* @param name The name of the topic. It must have the format
* @param name Required. The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only
* letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`),
* tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
Expand All @@ -217,7 +217,7 @@ public final Topic createTopic(ProjectTopicName name) {
* }
* </code></pre>
*
* @param name The name of the topic. It must have the format
* @param name Required. The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only
* letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`),
* tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
Expand Down Expand Up @@ -345,9 +345,9 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
* }
* </code></pre>
*
* @param topic The messages in the request will be published on this topic. Format is
* @param topic Required. The messages in the request will be published on this topic. Format is
* `projects/{project}/topics/{topic}`.
* @param messages The messages to publish.
* @param messages Required. The messages to publish.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final PublishResponse publish(
Expand Down Expand Up @@ -378,9 +378,9 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
* }
* </code></pre>
*
* @param topic The messages in the request will be published on this topic. Format is
* @param topic Required. The messages in the request will be published on this topic. Format is
* `projects/{project}/topics/{topic}`.
* @param messages The messages to publish.
* @param messages Required. The messages to publish.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
/* package-private */ final PublishResponse publish(String topic, List<PubsubMessage> messages) {
Expand Down Expand Up @@ -459,7 +459,8 @@ public final UnaryCallable<UpdateTopicRequest, Topic> updateTopicCallable() {
* }
* </code></pre>
*
* @param topic The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
* @param topic Required. The name of the topic to get. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Topic getTopic(ProjectTopicName topic) {
Expand All @@ -481,7 +482,8 @@ public final Topic getTopic(ProjectTopicName topic) {
* }
* </code></pre>
*
* @param topic The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
* @param topic Required. The name of the topic to get. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Topic getTopic(String topic) {
Expand Down Expand Up @@ -549,7 +551,7 @@ public final UnaryCallable<GetTopicRequest, Topic> getTopicCallable() {
* }
* </code></pre>
*
* @param project The name of the project in which to list topics. Format is
* @param project Required. The name of the project in which to list topics. Format is
* `projects/{project-id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand All @@ -576,7 +578,7 @@ public final ListTopicsPagedResponse listTopics(ProjectName project) {
* }
* </code></pre>
*
* @param project The name of the project in which to list topics. Format is
* @param project Required. The name of the project in which to list topics. Format is
* `projects/{project-id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -680,7 +682,7 @@ public final UnaryCallable<ListTopicsRequest, ListTopicsResponse> listTopicsCall
* }
* </code></pre>
*
* @param topic The name of the topic that subscriptions are attached to. Format is
* @param topic Required. The name of the topic that subscriptions are attached to. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand All @@ -707,7 +709,7 @@ public final ListTopicSubscriptionsPagedResponse listTopicSubscriptions(ProjectT
* }
* </code></pre>
*
* @param topic The name of the topic that subscriptions are attached to. Format is
* @param topic Required. The name of the topic that subscriptions are attached to. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -816,7 +818,8 @@ public final ListTopicSubscriptionsPagedResponse listTopicSubscriptions(
* }
* </code></pre>
*
* @param topic Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
* @param topic Required. Name of the topic to delete. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTopic(ProjectTopicName topic) {
Expand All @@ -841,7 +844,8 @@ public final void deleteTopic(ProjectTopicName topic) {
* }
* </code></pre>
*
* @param topic Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
* @param topic Required. Name of the topic to delete. Format is
* `projects/{project}/topics/{topic}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTopic(String topic) {
Expand Down Expand Up @@ -904,6 +908,8 @@ public final UnaryCallable<DeleteTopicRequest, Empty> deleteTopicCallable() {
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
*
* <p>Sample code:
*
* <pre><code>
Expand Down Expand Up @@ -931,6 +937,8 @@ public final Policy setIamPolicy(String resource, Policy policy) {
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
*
* <p>Sample code:
*
* <pre><code>
Expand All @@ -956,6 +964,8 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) {
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* <p>Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
*
* <p>Sample code:
*
* <pre><code>
Expand Down
Expand Up @@ -15,7 +15,7 @@
*/

/**
* A client to Google Cloud Pub/Sub API.
* A client to Cloud Pub/Sub API.
*
* <p>The interfaces provided are listed below, along with usage samples.
*
Expand Down
Expand Up @@ -36,7 +36,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* gRPC callable factory implementation for Google Cloud Pub/Sub API.
* gRPC callable factory implementation for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage.
*/
Expand Down
Expand Up @@ -52,7 +52,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* gRPC stub implementation for Google Cloud Pub/Sub API.
* gRPC stub implementation for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage and reflects the underlying API directly.
*/
Expand Down
Expand Up @@ -36,7 +36,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* gRPC callable factory implementation for Google Cloud Pub/Sub API.
* gRPC callable factory implementation for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage.
*/
Expand Down
Expand Up @@ -64,7 +64,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* gRPC stub implementation for Google Cloud Pub/Sub API.
* gRPC stub implementation for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage and reflects the underlying API directly.
*/
Expand Down
Expand Up @@ -41,7 +41,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* Base stub class for Google Cloud Pub/Sub API.
* Base stub class for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage and reflects the underlying API directly.
*/
Expand Down
Expand Up @@ -53,7 +53,7 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS
/**
* Base stub class for Google Cloud Pub/Sub API.
* Base stub class for Cloud Pub/Sub API.
*
* <p>This class is for advanced usage and reflects the underlying API directly.
*/
Expand Down

0 comments on commit 63c147a

Please sign in to comment.