Skip to content

Provide correct API for monitoring an LRO (instances). #4045

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

Merged
merged 1 commit into from
Sep 25, 2017
Merged

Provide correct API for monitoring an LRO (instances). #4045

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: 6 additions & 14 deletions docs/spanner/instance-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,32 +141,24 @@ Delete an instance using its

.. _check-on-current-instance-operation:

Check on Current Instance Operation
-----------------------------------
Resolve Current Instance Operation
----------------------------------

The :meth:`~google.cloud.spanner.instance.Instance.create` and
:meth:`~google.cloud.spanner.instance.Instance.update` methods of instance
object trigger long-running operations on the server, and return instances
of the :class:`~google.cloud.spanner.instance.Operation` class.

You can check if a long-running operation has finished
by using its :meth:`~google.cloud.spanner.instance.Operation.finished`
method:
If you want to block on the completion of those operations, use the
``result`` method on the returned objects:

.. code:: python

>>> operation = instance.create()
>>> operation.finished()
True
>>> result = operation.result()

.. note::
This method will raise an exception if the operation fails.

Once an :class:`~google.cloud.spanner.instance.Operation` object
has returned :data:`True` from its
:meth:`~google.cloud.spanner.instance.Operation.finished` method, the
object should not be re-used. Subsequent calls to
:meth:`~google.cloud.spanner.instance.Operation.finished`
will result in an :exc`ValueError` being raised.

Next Step
---------
Expand Down