Google_Service_Genomics_Variantsets_Resource Class Reference

The "variantsets" collection of methods. More...

Inheritance diagram for Google_Service_Genomics_Variantsets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_Genomics_VariantSet $postBody, $optParams=array())
	Creates a new variant set.
	delete ($variantSetId, $optParams=array())
	Deletes the contents of a variant set.
	export ($variantSetId, Google_Service_Genomics_ExportVariantSetRequest $postBody, $optParams=array())
	Exports variant set data to an external destination.
	get ($variantSetId, $optParams=array())
	Gets a variant set by ID.
	patch ($variantSetId, Google_Service_Genomics_VariantSet $postBody, $optParams=array())
	Updates a variant set.
	search (Google_Service_Genomics_SearchVariantSetsRequest $postBody, $optParams=array())
	Returns a list of all variant sets matching search criteria.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "variantsets" collection of methods.

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

Member Function Documentation

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

Google_Exception

create()

Google_Service_Genomics_Variantsets_Resource::create	(	Google_Service_Genomics_VariantSet	$postBody,
			$optParams = array() )

Creates a new variant set.

The provided variant set must have a valid datasetId set - all other fields are optional. Note that the id field will be ignored, as this is assigned by the server. (variantsets.create)

Parameters

Google_VariantSet	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_VariantSet

delete()

Google_Service_Genomics_Variantsets_Resource::delete	(		$variantSetId,
			$optParams = array() )

Deletes the contents of a variant set.

The variant set object is not deleted. (variantsets.delete)

Parameters

string	$variantSetId	The ID of the variant set to be deleted.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Empty

export()

Google_Service_Genomics_Variantsets_Resource::export	(		$variantSetId,
		Google_Service_Genomics_ExportVariantSetRequest	$postBody,
			$optParams = array() )

Exports variant set data to an external destination.

(variantsets.export)

Parameters

string	$variantSetId	Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set.
Google_ExportVariantSetRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Operation

get()

Google_Service_Genomics_Variantsets_Resource::get	(		$variantSetId,
			$optParams = array() )

Gets a variant set by ID.

(variantsets.get)

Parameters

string	$variantSetId	Required. The ID of the variant set.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_VariantSet

patch()

Google_Service_Genomics_Variantsets_Resource::patch	(		$variantSetId,
		Google_Service_Genomics_VariantSet	$postBody,
			$optParams = array() )

Updates a variant set.

This method supports patch semantics. (variantsets.patch)

Parameters

string	$variantSetId	The ID of the variant to be updated (must already exist).
Google_VariantSet	$postBody
array	$optParams	Optional parameters.

@opt_param string updateMask An optional mask specifying which fields to update. At this time, the only mutable field is metadata. The only acceptable value is "metadata". If unspecified, all mutable fields will be updated.

Return values

Google_Service_Genomics_VariantSet

search()

Google_Service_Genomics_Variantsets_Resource::search	(	Google_Service_Genomics_SearchVariantSetsRequest	$postBody,
			$optParams = array() )

Returns a list of all variant sets matching search criteria.

Implements Glob alAllianceApi.searchVariantSets. (variantsets.search)

Parameters

Google_SearchVariantSetsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_SearchVariantSetsResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Genomics.php