Uiv1beta3ProjectsLocationsOperations
class Uiv1beta3ProjectsLocationsOperations extends Resource (View source)
The "operations" collection of methods.
Typical usage is:
$documentaiService = new Google\Service\Document(...);
$operations = $documentaiService->operations;Methods
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. (operations.get)
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the
name binding allows API services to override the binding to use different
resource name schemes, such as users/operations. To override the binding,
API services can add a binding such as "/v1/{name=users}/operations" to
their service configuration. For backwards compatibility, the default name
includes the operations collection id, however overriding users must ensure
the name binding is the parent resource, without the operations collection
id. (operations.listUiv1beta3ProjectsLocationsOperations)
Details
GoogleProtobufEmpty
cancel(string $name, array $optParams = [])
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
google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation, the
operation is not deleted; instead, it becomes an operation with an
Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED. (operations.cancel)
GoogleLongrunningOperation
get(string $name, array $optParams = [])
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. (operations.get)
GoogleLongrunningListOperationsResponse
listUiv1beta3ProjectsLocationsOperations(string $name, array $optParams = [])
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the
name binding allows API services to override the binding to use different
resource name schemes, such as users/operations. To override the binding,
API services can add a binding such as "/v1/{name=users}/operations" to
their service configuration. For backwards compatibility, the default name
includes the operations collection id, however overriding users must ensure
the name binding is the parent resource, without the operations collection
id. (operations.listUiv1beta3ProjectsLocationsOperations)