Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: switch to proto annotations #90

Merged
merged 1 commit into from Feb 27, 2020
Merged

docs: switch to proto annotations #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
148 changes: 78 additions & 70 deletions google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 24 additions & 14 deletions google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/TopicAdminClient.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/package-info.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion ...ud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcPublisherCallableFactory.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcPublisherStub.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion ...d-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcSubscriberCallableFactory.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/GrpcSubscriberStub.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/PublisherStub.java
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/stub/SubscriberStub.java
View file
Open in desktop
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