generated/google/apis/genomics_v1/service.rb in google-api-client-0.20.0 vs generated/google/apis/genomics_v1/service.rb in google-api-client-0.20.1
- old
+ new
@@ -446,13 +446,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new call set.
- # For the definitions of call sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [Google::Apis::GenomicsV1::CallSet] call_set_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -479,13 +476,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a call set.
- # For the definitions of call sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] call_set_id
# The ID of the call set to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -512,13 +506,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a call set by ID.
- # For the definitions of call sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] call_set_id
# The ID of the call set.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -545,13 +536,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a call set.
- # For the definitions of call sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# This method supports patch semantics.
# @param [String] call_set_id
# The ID of the call set to be updated.
# @param [Google::Apis::GenomicsV1::CallSet] call_set_object
# @param [String] update_mask
@@ -588,13 +576,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a list of call sets matching the criteria.
- # For the definitions of call sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.
# 1/src/main/resources/avro/variantmethods.avdl#L178).
# @param [Google::Apis::GenomicsV1::SearchCallSetsRequest] search_call_sets_request_object
# @param [String] fields
@@ -624,13 +609,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new dataset.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [Google::Apis::GenomicsV1::Dataset] dataset_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -662,13 +644,10 @@
# reference sets, variant sets, call sets, annotation sets, etc.)
# This is reversible (up to one week after the deletion) via
# the
# datasets.undelete
# operation.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] dataset_id
# The ID of the dataset to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -695,13 +674,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a dataset by ID.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] dataset_id
# The ID of the dataset.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -731,13 +707,10 @@
# Gets the access control policy for the dataset. This is empty if the
# policy or resource does not exist.
# See <a href="/iam/docs/managing-policies#getting_a_policy">Getting a
# Policy</a> for more information.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] resource
# REQUIRED: The resource for which policy is being specified. Format is
# `datasets/<dataset ID>`.
# @param [Google::Apis::GenomicsV1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
@@ -768,13 +741,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists datasets within a project.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [Fixnum] page_size
# The maximum number of results to return in a single page. If unspecified,
# defaults to 50. The maximum value is 1024.
# @param [String] page_token
# The continuation token, which is used to page through large result sets.
@@ -810,13 +780,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a dataset.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# This method supports patch semantics.
# @param [String] dataset_id
# The ID of the dataset to be updated.
# @param [Google::Apis::GenomicsV1::Dataset] dataset_object
# @param [String] update_mask
@@ -854,13 +821,10 @@
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified dataset. Replaces any
# existing policy.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# See <a href="/iam/docs/managing-policies#setting_a_policy">Setting a
# Policy</a> for more information.
# @param [String] resource
# REQUIRED: The resource for which policy is being specified. Format is
# `datasets/<dataset ID>`.
@@ -895,13 +859,10 @@
end
# Returns permissions that a caller has on the specified resource.
# See <a href="/iam/docs/managing-policies#testing_permissions">Testing
# Permissions</a> for more information.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] resource
# REQUIRED: The resource for which policy is being specified. Format is
# `datasets/<dataset ID>`.
# @param [Google::Apis::GenomicsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
@@ -932,13 +893,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Undeletes a dataset by restoring a dataset which was deleted via this API.
- # For the definitions of datasets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# This operation is only possible for a week after the deletion occurred.
# @param [String] dataset_id
# The ID of the dataset to be undeleted.
# @param [Google::Apis::GenomicsV1::UndeleteDatasetRequest] undelete_dataset_request_object
# @param [String] fields
@@ -1100,13 +1058,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a read group set.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] read_group_set_id
# 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.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -1134,13 +1089,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports a read group set to a BAM file in Google Cloud Storage.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# 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.
# @param [String] read_group_set_id
@@ -1175,13 +1127,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a read group set by ID.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] read_group_set_id
# The ID of the read group set.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1209,13 +1158,10 @@
execute_or_queue_command(command, &block)
end
# Creates read group sets by asynchronously importing the provided
# information.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# The caller must have WRITE permissions to the dataset.
# ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) 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
@@ -1251,13 +1197,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a read group set.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# This method supports patch semantics.
# @param [String] read_group_set_id
# 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.
# @param [Google::Apis::GenomicsV1::ReadGroupSet] read_group_set_object
@@ -1296,13 +1239,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for read group sets matching the criteria.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/
# v0.5.1/src/main/resources/avro/readmethods.avdl#L135).
# @param [Google::Apis::GenomicsV1::SearchReadGroupSetsRequest] search_read_group_sets_request_object
# @param [String] fields
@@ -1334,13 +1274,10 @@
end
# Lists fixed width coverage buckets for a read group set, each of which
# correspond to a range of a reference sequence. Each bucket summarizes
# coverage information across its corresponding genomic range.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Coverage is defined as the number of reads which are aligned to a given
# base in the reference sequence. Coverage buckets are available at several
# precomputed bucket widths, enabling retrieval of various coverage 'zoom
# levels'. The caller must have READ permissions for the target read group
# set.
@@ -1403,13 +1340,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a list of reads for one or more read group sets.
- # For the definitions of read group sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Reads search operates over a genomic coordinate space of reference sequence
# & position defined over the reference sequences to which the requested
# read group sets are aligned.
# If a target positional range is specified, search returns all reads whose
# alignment to the reference genome overlap the range. A query which
@@ -1452,13 +1386,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a reference.
- # For the definitions of references and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/
# src/main/resources/avro/referencemethods.avdl#L158).
# @param [String] reference_id
# The ID of the reference.
@@ -1488,13 +1419,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for references which match the given criteria.
- # For the definitions of references and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.
# 5.1/src/main/resources/avro/referencemethods.avdl#L146).
# @param [Google::Apis::GenomicsV1::SearchReferencesRequest] search_references_request_object
# @param [String] fields
@@ -1524,13 +1452,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the bases in a reference, optionally restricted to a range.
- # For the definitions of references and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.
# 5.1/src/main/resources/avro/referencemethods.avdl#L221).
# @param [String] reference_id
# The ID of the reference.
@@ -1577,13 +1502,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a reference set.
- # For the definitions of references and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.
# 1/src/main/resources/avro/referencemethods.avdl#L83).
# @param [String] reference_set_id
# The ID of the reference set.
@@ -1613,13 +1535,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for reference sets which match the given criteria.
- # For the definitions of references and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/
# v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)
# @param [Google::Apis::GenomicsV1::SearchReferenceSetsRequest] search_reference_sets_request_object
# @param [String] fields
@@ -1649,13 +1568,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new variant.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [Google::Apis::GenomicsV1::Variant] variant_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -1682,13 +1598,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a variant.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_id
# The ID of the variant to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1715,13 +1628,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a variant by ID.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_id
# The ID of the variant.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1748,13 +1658,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates variant data by asynchronously importing the provided information.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# 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 Variant info fields are merged
@@ -1792,13 +1699,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Merges the given variants with existing variants.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Each variant will be
# merged with an 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
@@ -1903,13 +1807,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a variant.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# This method supports patch semantics. Returns the modified variant without
# its calls.
# @param [String] variant_id
# The ID of the variant to be updated.
# @param [Google::Apis::GenomicsV1::Variant] variant_object
@@ -1947,13 +1848,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a list of variants matching the criteria.
- # For the definitions of variants and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.
# 1/src/main/resources/avro/variantmethods.avdl#L126).
# @param [Google::Apis::GenomicsV1::SearchVariantsRequest] search_variants_request_object
# @param [String] fields
@@ -1983,13 +1881,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new variant set.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# 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.
# @param [Google::Apis::GenomicsV1::VariantSet] variant_set_object
# @param [String] fields
@@ -2020,13 +1915,10 @@
execute_or_queue_command(command, &block)
end
# Deletes a variant set including all variants, call sets, and calls within.
# This is not reversible.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_set_id
# The ID of the variant set to be deleted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -2053,13 +1945,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports variant set data to an external destination.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_set_id
# 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.
# @param [Google::Apis::GenomicsV1::ExportVariantSetRequest] export_variant_set_request_object
# @param [String] fields
@@ -2090,13 +1979,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a variant set by ID.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_set_id
# Required. The ID of the variant set.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -2123,13 +2009,10 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a variant set using patch semantics.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# @param [String] variant_set_id
# The ID of the variant to be updated (must already exist).
# @param [Google::Apis::GenomicsV1::VariantSet] variant_set_object
# @param [String] update_mask
# An optional mask specifying which fields to update. Supported fields:
@@ -2167,12 +2050,9 @@
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of all variant sets matching search criteria.
- # For the definitions of variant sets and other genomics resources, see
- # [Fundamentals of Google
- # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
# Implements
# [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.
# 5.1/src/main/resources/avro/variantmethods.avdl#L49).
# @param [Google::Apis::GenomicsV1::SearchVariantSetsRequest] search_variant_sets_request_object
# @param [String] fields