Documentation

Google_Service_Genomics_Resource_Operations extends Google_Service_Resource
in package

The "operations" collection of methods.

Typical usage is: $genomicsService = new Google_Service_Genomics(...); $operations = $genomicsService->operations;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
cancel()  : Google_Service_Genomics_GenomicsEmpty
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Genomics_Operation
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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` (operations.get)
listOperations()  : Google_Service_Genomics_ListOperationsResponse
Lists operations that match the specified filter in the request.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

cancel()

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

public cancel(string $name, Google_Service_Genomics_CancelOperationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Genomics_GenomicsEmpty

Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission: * genomics.operations.cancel (operations.cancel)

Parameters
$name : string

The name of the operation resource to be cancelled.

$postBody : Google_Service_Genomics_CancelOperationRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Genomics_GenomicsEmpty —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` (operations.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Genomics_Operation
Parameters
$name : string

The name of the operation resource.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Genomics_Operation —

listOperations()

Lists operations that match the specified filter in the request.

public listOperations(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Genomics_ListOperationsResponse

Authorization requires the following Google IAM permission: * genomics.operations.list (operations.listOperations)

Parameters
$name : string

The name of the operation's parent resource.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The maximum number of results to return. The maximum value is 256.

opt_param

string pageToken The standard list page token.

opt_param

string filter A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, 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 <= operators. * status: Can be RUNNING, SUCCESS, FAILURE, or CANCELED. Only one status may be specified. * labels.key where key is a label key. Examples: * projectId = my-project AND createTime >= 1432140000 * projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING * projectId = my-project AND labels.color = * * projectId = my-project AND labels.color = red
Return values
Google_Service_Genomics_ListOperationsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results