aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/googleapis-common-protos/google/longrunning/README.md
diff options
context:
space:
mode:
authorkomels <komels@yandex-team.ru>2022-04-14 13:10:53 +0300
committerkomels <komels@yandex-team.ru>2022-04-14 13:10:53 +0300
commit21c9b0e6b039e9765eb414c406c2b86e8cea6850 (patch)
treef40ebc18ff8958dfbd189954ad024043ca983ea5 /contrib/libs/googleapis-common-protos/google/longrunning/README.md
parent9a4effa852abe489707139c2b260dccc6f4f9aa9 (diff)
downloadydb-21c9b0e6b039e9765eb414c406c2b86e8cea6850.tar.gz
Final part on compatibility layer: LOGBROKER-7215
ref:777c67aadbf705d19034a09a792b2df61ba53697
Diffstat (limited to 'contrib/libs/googleapis-common-protos/google/longrunning/README.md')
-rw-r--r--contrib/libs/googleapis-common-protos/google/longrunning/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/contrib/libs/googleapis-common-protos/google/longrunning/README.md b/contrib/libs/googleapis-common-protos/google/longrunning/README.md
new file mode 100644
index 0000000000..7eba891ea0
--- /dev/null
+++ b/contrib/libs/googleapis-common-protos/google/longrunning/README.md
@@ -0,0 +1,31 @@
+## Long-running Operations API
+
+This package contains the definition of an abstract interface that
+manages long running operations with API services.
+
+### Operation
+
+The primary message to understand within LRO is the `Operation` message.
+Operations have a unique name (in the context of a particular endpoint).
+Additionally, a service (called `Operations` -- plural) defines the interface
+for querying the state of any given operation.
+
+APIs that implement a concept of long-running operations are encouraged
+to follow this pattern: When a caller invokes an API backend to start a job...
+
+ * The API backend starts asychronous work to fulfill the caller's
+ request, and generates a unique name (the `Operation` name) to refer
+ to the ongoing asychronous work.
+ * The API backend immediately returns the `Operation` back to the caller.
+ * The caller can invoke the API methods defined in the `Operations` service
+ to get the current status of the asychronous work, and also to
+ discover the final result (success or error).
+
+For Google APIs, the implementation of this pattern and the use of this
+proto are part of our [design rules][operations-rules]. Additionally, our
+[API client tooling][gapic-generator] seeks to be intelligent about these, to
+improve the client API consumption experience. Therefore, APIs outside of
+Google can also benefit by following this same pattern.
+
+ [operations-rules]: https://cloud.google.com/apis/design/design_patterns#long_running_operations
+ [gapic-generator]: https://github.com/googleapis/gapic-generator