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

Pub/sub: pick up stub docstring fix in GAPIC generator. #6978

Merged
merged 1 commit into from
Jan 4, 2019
Merged

Pub/sub: pick up stub docstring fix in GAPIC generator. #6978

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions pubsub/google/cloud/pubsub_v1/gapic/transports/publisher_grpc_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def channel(self):

@property
def create_topic(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.create_topic`.

Creates the given topic with the given name. See the resource name
rules.
Expand All @@ -116,7 +116,7 @@ def create_topic(self):

@property
def update_topic(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.update_topic`.

Updates an existing topic. Note that certain properties of a
topic are not modifiable.
Expand All @@ -130,7 +130,7 @@ def update_topic(self):

@property
def publish(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.publish`.

Adds one or more messages to the topic. Returns ``NOT_FOUND`` if the
topic does not exist.
Expand All @@ -144,7 +144,7 @@ def publish(self):

@property
def get_topic(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.get_topic`.

Gets the configuration of a topic.

Expand All @@ -157,7 +157,7 @@ def get_topic(self):

@property
def list_topics(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.list_topics`.

Lists matching topics.

Expand All @@ -170,7 +170,7 @@ def list_topics(self):

@property
def list_topic_subscriptions(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.list_topic_subscriptions`.

Lists the names of the subscriptions on this topic.

Expand All @@ -183,7 +183,7 @@ def list_topic_subscriptions(self):

@property
def delete_topic(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.delete_topic`.

Deletes the topic with the given name. Returns ``NOT_FOUND`` if the
topic does not exist. After a topic is deleted, a new topic may be
Expand All @@ -201,7 +201,7 @@ def delete_topic(self):

@property
def set_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.set_iam_policy`.

Sets the access control policy on the specified resource. Replaces any
existing policy.
Expand All @@ -215,7 +215,7 @@ def set_iam_policy(self):

@property
def get_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.get_iam_policy`.

Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
Expand All @@ -230,7 +230,7 @@ def get_iam_policy(self):

@property
def test_iam_permissions(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`PublisherClient.test_iam_permissions`.

Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions,
Expand Down
36 changes: 18 additions & 18 deletions pubsub/google/cloud/pubsub_v1/gapic/transports/subscriber_grpc_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def channel(self):

@property
def create_subscription(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.create_subscription`.

Creates a subscription to a given topic. See the resource name rules. If
the subscription already exists, returns ``ALREADY_EXISTS``. If the
Expand All @@ -124,7 +124,7 @@ def create_subscription(self):

@property
def get_subscription(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.get_subscription`.

Gets the configuration details of a subscription.

Expand All @@ -137,7 +137,7 @@ def get_subscription(self):

@property
def update_subscription(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.update_subscription`.

Updates an existing subscription. Note that certain properties of a
subscription, such as its topic, are not modifiable.
Expand All @@ -151,7 +151,7 @@ def update_subscription(self):

@property
def list_subscriptions(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.list_subscriptions`.

Lists matching subscriptions.

Expand All @@ -164,7 +164,7 @@ def list_subscriptions(self):

@property
def delete_subscription(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.delete_subscription`.

Deletes an existing subscription. All messages retained in the
subscription are immediately dropped. Calls to ``Pull`` after deletion
Expand All @@ -182,7 +182,7 @@ def delete_subscription(self):

@property
def modify_ack_deadline(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.modify_ack_deadline`.

Modifies the ack deadline for a specific message. This method is useful
to indicate that more time is needed to process a message by the
Expand All @@ -199,7 +199,7 @@ def modify_ack_deadline(self):

@property
def acknowledge(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.acknowledge`.

Acknowledges the messages associated with the ``ack_ids`` in the
``AcknowledgeRequest``. The Pub/Sub system can remove the relevant
Expand All @@ -218,7 +218,7 @@ def acknowledge(self):

@property
def pull(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.pull`.

Pulls messages from the server. The server may return ``UNAVAILABLE`` if
there are too many concurrent pull requests pending for the given
Expand All @@ -233,7 +233,7 @@ def pull(self):

@property
def streaming_pull(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.streaming_pull`.

Establishes a stream with the server, which sends messages down to the
client. The client streams acknowledgements and ack deadline
Expand All @@ -252,7 +252,7 @@ def streaming_pull(self):

@property
def modify_push_config(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.modify_push_config`.

Modifies the ``PushConfig`` for a specified subscription.

Expand All @@ -271,7 +271,7 @@ def modify_push_config(self):

@property
def list_snapshots(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.list_snapshots`.

Lists the existing snapshots.<br><br>
<b>ALPHA:</b> This feature is part of an alpha release. This API might be
Expand All @@ -287,7 +287,7 @@ def list_snapshots(self):

@property
def create_snapshot(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.create_snapshot`.

Creates a snapshot from the requested subscription. ALPHA: This feature
is part of an alpha release. This API might be changed in
Expand All @@ -313,7 +313,7 @@ def create_snapshot(self):

@property
def update_snapshot(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.update_snapshot`.

Updates an existing snapshot.<br><br>
<b>ALPHA:</b> This feature is part of an alpha release. This API might be
Expand All @@ -330,7 +330,7 @@ def update_snapshot(self):

@property
def delete_snapshot(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.delete_snapshot`.

Removes an existing snapshot. <br><br>
<b>ALPHA:</b> This feature is part of an alpha release. This API might be
Expand All @@ -350,7 +350,7 @@ def delete_snapshot(self):

@property
def seek(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.seek`.

Seeks an existing subscription to a point in time or to a given snapshot,
whichever is provided in the request.<br><br>
Expand All @@ -367,7 +367,7 @@ def seek(self):

@property
def set_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.set_iam_policy`.

Sets the access control policy on the specified resource. Replaces any
existing policy.
Expand All @@ -381,7 +381,7 @@ def set_iam_policy(self):

@property
def get_iam_policy(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.get_iam_policy`.

Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
Expand All @@ -396,7 +396,7 @@ def get_iam_policy(self):

@property
def test_iam_permissions(self):
"""Return the gRPC stub for {$apiMethod.name}.
"""Return the gRPC stub for :meth:`SubscriberClient.test_iam_permissions`.

Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions,
Expand Down
10 changes: 5 additions & 5 deletions pubsub/synth.metadata
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2018-12-07T13:23:18.328036Z",
"updateTime": "2018-12-18T13:23:31.222196Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.2",
"dockerImage": "googleapis/artman@sha256:2f6b261ee7fe1aedf238991c93a20b3820de37a343d0cacf3e3e9555c2aaf2ea"
"version": "0.16.3",
"dockerImage": "googleapis/artman@sha256:bfb92654b4a77368471f70e2808eaf4e60f263b9559f27bb3284097322787bf1"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "200fbbe59cc7b0077ae525eb5f3d6420c0c53e61",
"internalRef": "224174014"
"sha": "c04bc0dc0a9164d924a9ab923fd6845b4ae6a7ab",
"internalRef": "225851467"
}
},
{
Expand Down