class ProjectsLocationsOperations extends Resource (View source)

The "operations" collection of methods.

Typical usage is:

 $apigatewayService = new Google\Service\Apigateway(...);
 $operations = $apigatewayService->projects_locations_operations;

Methods

cancel(string $name, ApigatewayCancelOperationRequest $postBody, 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.

delete(string $name, array $optParams = [])

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.

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)

listProjectsLocationsOperations(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.

Details

ApigatewayEmpty cancel(string $name, ApigatewayCancelOperationRequest $postBody, 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)

Parameters

string $name

The name of the operation resource to be cancelled.

ApigatewayCancelOperationRequest $postBody
array $optParams

Optional parameters.

Return Value

ApigatewayEmpty

Exceptions

Exception

ApigatewayEmpty delete(string $name, array $optParams = [])

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 google.rpc.Code.UNIMPLEMENTED. (operations.delete)

Parameters

string $name

The name of the operation resource to be deleted.

array $optParams

Optional parameters.

Return Value

ApigatewayEmpty

Exceptions

Exception

ApigatewayOperation 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)

Parameters

string $name

The name of the operation resource.

array $optParams

Optional parameters.

Return Value

ApigatewayOperation

Exceptions

Exception

ApigatewayListOperationsResponse listProjectsLocationsOperations(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.

(operations.listProjectsLocationsOperations)

Parameters

string $name

The name of the operation's parent resource.

array $optParams

Optional parameters.

Return Value

ApigatewayListOperationsResponse

Exceptions

Exception