Skip to content

Documentation: Improve Docstrings in modules google/pubsub_v1/services/subscriber #1021

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documentation: Improve Docstrings in modules google/pubsub_v1/services/subscriber #1021

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
8 changes: 4 additions & 4 deletions google/pubsub_v1/services/subscriber/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,8 @@ async def create_subscription(
r"""Creates a subscription to a given topic. See the [resource name
rules]
(https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
If the subscription already exists, returns ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, returns ``NOT_FOUND``.
If the subscription already exists, raises ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, raises ``NOT_FOUND``.

If the name is not provided in the request, the server will
assign a random name for this subscription on the same project
Expand Down Expand Up @@ -1795,8 +1795,8 @@ async def create_snapshot(
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
If the snapshot already exists, returns ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, returns ``NOT_FOUND``.
If the snapshot already exists, raises ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, raises ``NOT_FOUND``.
If the backlog in the subscription is too old -- and the
resulting snapshot would expire in less than 1 hour -- then
``FAILED_PRECONDITION`` is returned. See also the
Expand Down
8 changes: 4 additions & 4 deletions google/pubsub_v1/services/subscriber/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,8 @@ def create_subscription(
r"""Creates a subscription to a given topic. See the [resource name
rules]
(https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
If the subscription already exists, returns ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, returns ``NOT_FOUND``.
If the subscription already exists, raises ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, raises ``NOT_FOUND``.

If the name is not provided in the request, the server will
assign a random name for this subscription on the same project
Expand Down Expand Up @@ -1952,8 +1952,8 @@ def create_snapshot(
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
If the snapshot already exists, returns ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, returns ``NOT_FOUND``.
If the snapshot already exists, raises ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, raises ``NOT_FOUND``.
If the backlog in the subscription is too old -- and the
resulting snapshot would expire in less than 1 hour -- then
``FAILED_PRECONDITION`` is returned. See also the
Expand Down
8 changes: 4 additions & 4 deletions google/pubsub_v1/services/subscriber/transports/grpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,8 @@ def create_subscription(
Creates a subscription to a given topic. See the [resource name
rules]
(https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
If the subscription already exists, returns ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, returns ``NOT_FOUND``.
If the subscription already exists, raises ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, raises ``NOT_FOUND``.

If the name is not provided in the request, the server will
assign a random name for this subscription on the same project
Expand Down Expand Up @@ -608,8 +608,8 @@ def create_snapshot(
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
If the snapshot already exists, returns ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, returns ``NOT_FOUND``.
If the snapshot already exists, raises ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, raises ``NOT_FOUND``.
If the backlog in the subscription is too old -- and the
resulting snapshot would expire in less than 1 hour -- then
``FAILED_PRECONDITION`` is returned. See also the
Expand Down
8 changes: 4 additions & 4 deletions google/pubsub_v1/services/subscriber/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ def create_subscription(
Creates a subscription to a given topic. See the [resource name
rules]
(https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
If the subscription already exists, returns ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, returns ``NOT_FOUND``.
If the subscription already exists, raises ``ALREADY_EXISTS``.
If the corresponding topic doesn't exist, raises ``NOT_FOUND``.

If the name is not provided in the request, the server will
assign a random name for this subscription on the same project
Expand Down Expand Up @@ -621,8 +621,8 @@ def create_snapshot(
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
If the snapshot already exists, returns ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, returns ``NOT_FOUND``.
If the snapshot already exists, raises ``ALREADY_EXISTS``. If
the requested subscription doesn't exist, raises ``NOT_FOUND``.
If the backlog in the subscription is too old -- and the
resulting snapshot would expire in less than 1 hour -- then
``FAILED_PRECONDITION`` is returned. See also the
Expand Down