The "operations" collection of methods.
More...
|
| call ($name, $arguments, $expected_class=null) |
| TODO: This function needs simplifying.
|
|
| cancel ($name, Google_Service_Genomics_CancelOperationRequest $postBody, $optParams=array()) |
| Starts asynchronous cancellation on a long-running operation.
|
|
| delete ($name, $optParams=array()) |
| This method is not implemented.
|
|
| get ($name, $optParams=array()) |
| Gets the latest state of a long-running operation.
|
|
| listOperations ($name, $optParams=array()) |
| Lists operations that match the specified filter in the request.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "operations" collection of methods.
Typical usage is: $genomicsService = new Google_Service_Genomics(...); $operations = $genomicsService->operations;
◆ call()
Google_Service_Resource::call |
( |
| $name, |
|
|
| $arguments, |
|
|
| $expected_class = null ) |
|
inherited |
TODO: This function needs simplifying.
- Parameters
-
$name | |
$arguments | |
$expected_class | - optional, the expected class name |
- Return values
-
Google_Http_Request|expected_class | |
- Exceptions
-
◆ cancel()
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. (operations.cancel)
- Parameters
-
string | $name | The name of the operation resource to be cancelled. |
Google_CancelOperationRequest | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ delete()
Google_Service_Genomics_Operations_Resource::delete |
( |
| $name, |
|
|
| $optParams = array() ) |
This method is not implemented.
To cancel an operation, please use Operations.CancelOperation. (operations.delete)
- Parameters
-
string | $name | The name of the operation resource to be deleted. |
array | $optParams | Optional parameters. |
- Return values
-
◆ get()
Google_Service_Genomics_Operations_Resource::get |
( |
| $name, |
|
|
| $optParams = array() ) |
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 values
-
◆ listOperations()
Google_Service_Genomics_Operations_Resource::listOperations |
( |
| $name, |
|
|
| $optParams = array() ) |
Lists operations that match the specified filter in the request.
(operations.listOperations)
- Parameters
-
string | $name | The name of the operation collection. |
array | $optParams | Optional parameters. |
@opt_param string filter A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the epoch. Can use >=
and/or = 1432140000
* projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING
@opt_param string pageToken The standard list page token. @opt_param int pageSize The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
- Return values
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Genomics.php