Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Genomics_Variants_Resource Class Reference

The "variants" collection of methods. More...

Inheritance diagram for Google_Service_Genomics_Variants_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create (Google_Service_Genomics_Variant $postBody, $optParams=array())
 Creates a new variant.
 
 delete ($variantId, $optParams=array())
 Deletes a variant.
 
 get ($variantId, $optParams=array())
 Gets a variant by ID.
 
 import (Google_Service_Genomics_ImportVariantsRequest $postBody, $optParams=array())
 Creates variant data by asynchronously importing the provided information.
 
 patch ($variantId, Google_Service_Genomics_Variant $postBody, $optParams=array())
 Updates a variant.
 
 search (Google_Service_Genomics_SearchVariantsRequest $postBody, $optParams=array())
 Gets a list of variants matching the criteria.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "variants" collection of methods.

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

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_Variants_Resource::create ( Google_Service_Genomics_Variant $postBody,
$optParams = array() )

Creates a new variant.

(variants.create)

Parameters
Google_Variant$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Genomics_Variant

◆ delete()

Google_Service_Genomics_Variants_Resource::delete ( $variantId,
$optParams = array() )

Deletes a variant.

(variants.delete)

Parameters
string$variantIdThe ID of the variant to be deleted.
array$optParamsOptional parameters.
Return values
Google_Service_Genomics_Empty

◆ get()

Google_Service_Genomics_Variants_Resource::get ( $variantId,
$optParams = array() )

Gets a variant by ID.

(variants.get)

Parameters
string$variantIdThe ID of the variant.
array$optParamsOptional parameters.
Return values
Google_Service_Genomics_Variant

◆ import()

Google_Service_Genomics_Variants_Resource::import ( Google_Service_Genomics_ImportVariantsRequest $postBody,
$optParams = array() )

Creates variant data by asynchronously importing the provided information.

The variants for import will be merged with any existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created. When variants are merged, the call information from the new variant is added to the existing variant, and other fields (such as key/value pairs) are discarded. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set. (variants.import)

Parameters
Google_ImportVariantsRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Genomics_Operation

◆ patch()

Google_Service_Genomics_Variants_Resource::patch ( $variantId,
Google_Service_Genomics_Variant $postBody,
$optParams = array() )

Updates a variant.

This method supports patch semantics. Returns the modified variant without its calls. (variants.patch)

Parameters
string$variantIdThe ID of the variant to be updated.
Google_Variant$postBody
array$optParamsOptional parameters.

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

Return values
Google_Service_Genomics_Variant

◆ search()

Google_Service_Genomics_Variants_Resource::search ( Google_Service_Genomics_SearchVariantsRequest $postBody,
$optParams = array() )

Gets a list of variants matching the criteria.

Implements GlobalAllianceApi. searchVariants. (variants.search)

Parameters
Google_SearchVariantsRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Genomics_SearchVariantsResponse

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