Google_Service_Genomics_Readgroupsets_Resource Class Reference

The "readgroupsets" collection of methods. More...

Inheritance diagram for Google_Service_Genomics_Readgroupsets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($readGroupSetId, $optParams=array())
	Deletes a read group set.
	export ($readGroupSetId, Google_Service_Genomics_ExportReadGroupSetRequest $postBody, $optParams=array())
	Exports a read group set to a BAM file in Google Cloud Storage.
	get ($readGroupSetId, $optParams=array())
	Gets a read group set by ID.
	import (Google_Service_Genomics_ImportReadGroupSetsRequest $postBody, $optParams=array())
	Creates read group sets by asynchronously importing the provided information.
	patch ($readGroupSetId, Google_Service_Genomics_ReadGroupSet $postBody, $optParams=array())
	Updates a read group set.
	search (Google_Service_Genomics_SearchReadGroupSetsRequest $postBody, $optParams=array())
	Searches for read group sets matching the criteria.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "readgroupsets" collection of methods.

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

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

delete()

Google_Service_Genomics_Readgroupsets_Resource::delete	(		$readGroupSetId,
			$optParams = array() )

Deletes a read group set.

(readgroupsets.delete)

Parameters

string	$readGroupSetId	The ID of the read group set to be deleted. The caller must have WRITE permissions to the dataset associated with this read group set.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Empty

export()

Google_Service_Genomics_Readgroupsets_Resource::export	(		$readGroupSetId,
		Google_Service_Genomics_ExportReadGroupSetRequest	$postBody,
			$optParams = array() )

Exports a read group set to a BAM file in Google Cloud Storage.

Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See ImportReadGroupSets for caveats. (readgroupsets.export)

Parameters

string	$readGroupSetId	Required. The ID of the read group set to export.
Google_ExportReadGroupSetRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Operation

get()

Google_Service_Genomics_Readgroupsets_Resource::get	(		$readGroupSetId,
			$optParams = array() )

Gets a read group set by ID.

(readgroupsets.get)

Parameters

string	$readGroupSetId	The ID of the read group set.
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_ReadGroupSet

import()

Google_Service_Genomics_Readgroupsets_Resource::import	(	Google_Service_Genomics_ImportReadGroupSetsRequest	$postBody,
			$optParams = array() )

Creates read group sets by asynchronously importing the provided information.

The caller must have WRITE permissions to the dataset. ## Notes on BAM import - Tags will be converted to strings - tag types are not preserved - Comments (@CO) in the input file header will not be preserved - Original header order of references (@SQ) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (and "BQ" tag, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position) (readgroupsets.import)

Parameters

Google_ImportReadGroupSetsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_Operation

patch()

Google_Service_Genomics_Readgroupsets_Resource::patch	(		$readGroupSetId,
		Google_Service_Genomics_ReadGroupSet	$postBody,
			$optParams = array() )

Updates a read group set.

This method supports patch semantics. (readgroupsets.patch)

Parameters

string	$readGroupSetId	The ID of the read group set to be updated. The caller must have WRITE permissions to the dataset associated with this read group set.
Google_ReadGroupSet	$postBody
array	$optParams	Optional parameters.

@opt_param string updateMask An optional mask specifying which fields to update. At this time, mutable fields are referenceSetId and name. Acceptable values are "referenceSetId" and "name". If unspecified, all mutable fields will be updated.

Return values

Google_Service_Genomics_ReadGroupSet

search()

Google_Service_Genomics_Readgroupsets_Resource::search	(	Google_Service_Genomics_SearchReadGroupSetsRequest	$postBody,
			$optParams = array() )

Searches for read group sets matching the criteria.

Implements GlobalAllianc eApi.searchReadGroupSets. (readgroupsets.search)

Parameters

Google_SearchReadGroupSetsRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Genomics_SearchReadGroupSetsResponse

---

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

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