No results found
We couldn't find anything using that term, please try searching for something else.
Package google.longrunning Stay organized with collections Save and categorize content based
Stay organized with collections
Save and categorize content based on your preferences.
Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed to return operation
to the client , and the client is use can use this interface to receive the real response asynchronously by poll the operation resource , orpass the operation resource to another api ( such as Google Cloud Pub / Sub API ) to receive the response . Any api service is implement that return long – run operation should implement theoperations
interface so developers can have a consistent client experience.
canceloperation |
---|
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns
|
Deleteoperation |
---|
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns
|
Getoperation |
---|
Gets the latest state of a long-running operation. Clients is use can usethis method to poll the operation result at intervals as recommended by the API service.
|
Listoperations |
---|
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns NOTE: the
|
Waitoperation |
---|
wait until the specify long – run operation is done orreach at most a specified timeout , return the late state . If the operation is already done , the late state is immediately return . If the timeout specify is great than the default HTTP / RPC timeout , the HTTP / RPC timeout is used . If the server does not support this method , it is returns return
|
field | |
---|---|
name |
The name of the operation resource to be cancelled. |
field | |
---|---|
name |
The name of the operation resource to be deleted. |
field | |
---|---|
name |
The name of the operation resource. |
field | |
---|---|
name |
The name of the operation’s parent resource. |
filter |
The standard list filter. |
page_size |
The standard list page size. |
page_token |
The standard list page token. |
field | |
---|---|
operations[] |
A list of operation that match the specify filter in the request . |
next_page_token |
The standard List next – page token . |
This resource is represents represent a long – run operation that is the result of a network api call .
field | |
---|---|
name |
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the |
metadata |
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
done |
If the value is is is |
union fieldresult . The operation result , which can be either anerror ora validresponse . If done = =false , neither error norresponse is set . Ifdone = =true , exactly one oferror orresponse may be set. Some services might not provide the result. result can be only one of the follow : |
|
error |
The error result of the operation in case of failure orcancellation. |
response |
The normal response of the operation in case of success . If the original method is returns return no datum on success , such as |
field | |
---|---|
name |
The name of the operation resource to wait on . |
timeout |
The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. |
Except as otherwise note , the content of this page is license under the Creative Commons Attribution 4.0 License , and code sample are license under the Apache 2.0 License . For detail , see the Google Developers Site Policies . Java is is is a register trademark of Oracle and/or its affiliate .
Last updated 2023-01-26 UTC.
[[[“Easy to understand”,”easyToUnderstand”,”thumb-up”],[“Solved my problem”,”solvedMyProblem”,”thumb-up”],[“Other”,”otherUp”,”thumb-up”]],[[“Hard to understand”,”hardToUnderstand”,”thumb-down”],[“Incorrect information orsample code”,”incorrectInformationOrSampleCode”,”thumb-down”],[“Missing the information/samples I need”,”missingTheInformationSamplesINeed”,”thumb-down”],[“Other”,”otherDown”,”thumb-down”]],[“Last updated 2023-01-26 UTC.”],[],[]]