Class: Google::Apis::GenomicsV1::GenomicsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/genomics_v1/service.rb

Overview

Genomics API

Stores, processes, explores and shares genomic data.

Examples:

require 'google/apis/genomics_v1'

Genomics = Google::Apis::GenomicsV1 # Alias the module
service = Genomics::GenomicsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeGenomicsService

Returns a new instance of GenomicsService.


45
46
47
# File 'generated/google/apis/genomics_v1/service.rb', line 45

def initialize
  super('https://genomics.googleapis.com/', '')
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/genomics_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


43
44
45
# File 'generated/google/apis/genomics_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_create_annotations(batch_create_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse

Creates one or more new annotations atomically. All annotations must belong to the same annotation set. Caller must have WRITE permission for this annotation set. For optimal performance, batch positionally adjacent annotations together. If the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will fail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed annotations will be created normally. For details on the requirements for each individual annotation resource, see CreateAnnotation.

Parameters:

  • batch_create_annotations_request_object (Google::Apis::GenomicsV1::BatchCreateAnnotationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


281
282
283
284
285
286
287
288
289
290
# File 'generated/google/apis/genomics_v1/service.rb', line 281

def batch_create_annotations(batch_create_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/annotations:batchCreate', options)
  command.request_representation = Google::Apis::GenomicsV1::BatchCreateAnnotationsRequest::Representation
  command.request_object = batch_create_annotations_request_object
  command.response_representation = Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::BatchCreateAnnotationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::GenomicsV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


858
859
860
861
862
863
864
865
866
867
868
# File 'generated/google/apis/genomics_v1/service.rb', line 858

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::GenomicsV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_annotation(annotation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Annotation

Creates a new annotation. Caller must have WRITE permission for the associated annotation set. The following fields are required: * annotationSetId * referenceName or referenceId ### Transcripts For annotations of type TRANSCRIPT, the following fields of transcript must be provided: * exons.start

  • exons.end All other fields may be optionally specified, unless documented as being server-generated (for example, the id field). The annotated range must be no longer than 100Mbp (mega base pairs). See the Annotation resource for additional restrictions on each field.

Parameters:

  • annotation_object (Google::Apis::GenomicsV1::Annotation) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


243
244
245
246
247
248
249
250
251
252
# File 'generated/google/apis/genomics_v1/service.rb', line 243

def create_annotation(annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/annotations', options)
  command.request_representation = Google::Apis::GenomicsV1::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation
  command.response_class = Google::Apis::GenomicsV1::Annotation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_annotation_set(annotation_set_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::AnnotationSet

Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).

Parameters:

  • annotation_set_object (Google::Apis::GenomicsV1::AnnotationSet) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


71
72
73
74
75
76
77
78
79
80
# File 'generated/google/apis/genomics_v1/service.rb', line 71

def create_annotation_set(annotation_set_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/annotationsets', options)
  command.request_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation
  command.request_object = annotation_set_object
  command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation
  command.response_class = Google::Apis::GenomicsV1::AnnotationSet
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_call_set(call_set_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::CallSet

Creates a new call set. For the definitions of call sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • call_set_object (Google::Apis::GenomicsV1::CallSet) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'generated/google/apis/genomics_v1/service.rb', line 1984

def create_call_set(call_set_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/callsets', options)
  command.request_representation = Google::Apis::GenomicsV1::CallSet::Representation
  command.request_object = call_set_object
  command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation
  command.response_class = Google::Apis::GenomicsV1::CallSet
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_dataset(dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Dataset

Creates a new dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • dataset_object (Google::Apis::GenomicsV1::Dataset) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


491
492
493
494
495
496
497
498
499
500
# File 'generated/google/apis/genomics_v1/service.rb', line 491

def create_dataset(dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/datasets', options)
  command.request_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.response_class = Google::Apis::GenomicsV1::Dataset
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_variant(variant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Variant

Creates a new variant. For the definitions of variants and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_object (Google::Apis::GenomicsV1::Variant) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'generated/google/apis/genomics_v1/service.rb', line 1518

def create_variant(variant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variants', options)
  command.request_representation = Google::Apis::GenomicsV1::Variant::Representation
  command.request_object = variant_object
  command.response_representation = Google::Apis::GenomicsV1::Variant::Representation
  command.response_class = Google::Apis::GenomicsV1::Variant
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_variantset(variant_set_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::VariantSet

Creates a new variant set. For the definitions of variant sets and other genomics resources, see 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.

Parameters:

  • variant_set_object (Google::Apis::GenomicsV1::VariantSet) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
# File 'generated/google/apis/genomics_v1/service.rb', line 1743

def create_variantset(variant_set_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variantsets', options)
  command.request_representation = Google::Apis::GenomicsV1::VariantSet::Representation
  command.request_object = variant_set_object
  command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation
  command.response_class = Google::Apis::GenomicsV1::VariantSet
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_annotation(annotation_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes an annotation. Caller must have WRITE permission for the associated annotation set.

Parameters:

  • annotation_id (String)

    The ID of the annotation to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


383
384
385
386
387
388
389
390
391
# File 'generated/google/apis/genomics_v1/service.rb', line 383

def delete_annotation(annotation_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/annotations/{annotationId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_annotationset(annotation_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

Parameters:

  • annotation_set_id (String)

    The ID of the annotation set to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


173
174
175
176
177
178
179
180
181
# File 'generated/google/apis/genomics_v1/service.rb', line 173

def delete_annotationset(annotation_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/annotationsets/{annotationSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['annotationSetId'] = annotation_set_id unless annotation_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_call_set(call_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes a call set. For the definitions of call sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • call_set_id (String)

    The ID of the call set to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2057
2058
2059
2060
2061
2062
2063
2064
2065
# File 'generated/google/apis/genomics_v1/service.rb', line 2057

def delete_call_set(call_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/callsets/{callSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['callSetId'] = call_set_id unless call_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_dataset(dataset_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes a dataset and all of its contents (all read group sets, 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

Parameters:

  • dataset_id (String)

    The ID of the dataset to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


599
600
601
602
603
604
605
606
607
# File 'generated/google/apis/genomics_v1/service.rb', line 599

def delete_dataset(dataset_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/datasets/{datasetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes a read group set. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • read_group_set_id (String)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1048
1049
1050
1051
1052
1053
1054
1055
1056
# File 'generated/google/apis/genomics_v1/service.rb', line 1048

def delete_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/readgroupsets/{readGroupSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_variant(variant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Deletes a variant. For the definitions of variants and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_id (String)

    The ID of the variant to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1592
1593
1594
1595
1596
1597
1598
1599
1600
# File 'generated/google/apis/genomics_v1/service.rb', line 1592

def delete_variant(variant_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/variants/{variantId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['variantId'] = variant_id unless variant_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

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

Parameters:

  • variant_set_id (String)

    The ID of the variant set to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1879
1880
1881
1882
1883
1884
1885
1886
1887
# File 'generated/google/apis/genomics_v1/service.rb', line 1879

def delete_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/variantsets/{variantSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.params['variantSetId'] = variant_set_id unless variant_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_read_group_sets(read_group_set_id, export_read_group_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Operation

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 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.

Parameters:

  • read_group_set_id (String)

    Required. The ID of the read group set to export. The caller must have READ access to this read group set.

  • export_read_group_set_request_object (Google::Apis::GenomicsV1::ExportReadGroupSetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


937
938
939
940
941
942
943
944
945
946
947
# File 'generated/google/apis/genomics_v1/service.rb', line 937

def export_read_group_sets(read_group_set_id, export_read_group_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/readgroupsets/{readGroupSetId}:export', options)
  command.request_representation = Google::Apis::GenomicsV1::ExportReadGroupSetRequest::Representation
  command.request_object = export_read_group_set_request_object
  command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV1::Operation
  command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_variant_set(variant_set_id, export_variant_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Operation

Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_set_id (String)

    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.

  • export_variant_set_request_object (Google::Apis::GenomicsV1::ExportVariantSetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'generated/google/apis/genomics_v1/service.rb', line 1778

def export_variant_set(variant_set_id, export_variant_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variantsets/{variantSetId}:export', options)
  command.request_representation = Google::Apis::GenomicsV1::ExportVariantSetRequest::Representation
  command.request_object = export_variant_set_request_object
  command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV1::Operation
  command.params['variantSetId'] = variant_set_id unless variant_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_annotation(annotation_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Annotation

Gets an annotation. Caller must have READ permission for the associated annotation set.

Parameters:

  • annotation_id (String)

    The ID of the annotation to be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


313
314
315
316
317
318
319
320
321
# File 'generated/google/apis/genomics_v1/service.rb', line 313

def get_annotation(annotation_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/annotations/{annotationId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation
  command.response_class = Google::Apis::GenomicsV1::Annotation
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_annotation_set(annotation_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::AnnotationSet

Gets an annotation set. Caller must have READ permission for the associated dataset.

Parameters:

  • annotation_set_id (String)

    The ID of the annotation set to be retrieved.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


103
104
105
106
107
108
109
110
111
# File 'generated/google/apis/genomics_v1/service.rb', line 103

def get_annotation_set(annotation_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/annotationsets/{annotationSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation
  command.response_class = Google::Apis::GenomicsV1::AnnotationSet
  command.params['annotationSetId'] = annotation_set_id unless annotation_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_call_set(call_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::CallSet

Gets a call set by ID. For the definitions of call sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • call_set_id (String)

    The ID of the call set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2089
2090
2091
2092
2093
2094
2095
2096
2097
# File 'generated/google/apis/genomics_v1/service.rb', line 2089

def get_call_set(call_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/callsets/{callSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation
  command.response_class = Google::Apis::GenomicsV1::CallSet
  command.params['callSetId'] = call_set_id unless call_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_dataset(dataset_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Dataset

Gets a dataset by ID. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • dataset_id (String)

    The ID of the dataset.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


524
525
526
527
528
529
530
531
532
# File 'generated/google/apis/genomics_v1/service.rb', line 524

def get_dataset(dataset_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/datasets/{datasetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.response_class = Google::Apis::GenomicsV1::Dataset
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_dataset_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Policy

Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See Getting a Policy for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being specified. Format is datasets/.

  • get_iam_policy_request_object (Google::Apis::GenomicsV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


709
710
711
712
713
714
715
716
717
718
719
# File 'generated/google/apis/genomics_v1/service.rb', line 709

def get_dataset_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::GenomicsV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::GenomicsV1::Policy::Representation
  command.response_class = Google::Apis::GenomicsV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::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.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


824
825
826
827
828
829
830
831
832
# File 'generated/google/apis/genomics_v1/service.rb', line 824

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ReadGroupSet

Gets a read group set by ID. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • read_group_set_id (String)

    The ID of the read group set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1080
1081
1082
1083
1084
1085
1086
1087
1088
# File 'generated/google/apis/genomics_v1/service.rb', line 1080

def get_read_group_set(read_group_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/readgroupsets/{readGroupSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation
  command.response_class = Google::Apis::GenomicsV1::ReadGroupSet
  command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_reference(reference_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Reference

Gets a reference. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi. getReference.

Parameters:

  • reference_id (String)

    The ID of the reference.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1361
1362
1363
1364
1365
1366
1367
1368
1369
# File 'generated/google/apis/genomics_v1/service.rb', line 1361

def get_reference(reference_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/references/{referenceId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Reference::Representation
  command.response_class = Google::Apis::GenomicsV1::Reference
  command.params['referenceId'] = reference_id unless reference_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_reference_set(reference_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ReferenceSet

Gets a reference set. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi. getReferenceSet.

Parameters:

  • reference_set_id (String)

    The ID of the reference set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1293
1294
1295
1296
1297
1298
1299
1300
1301
# File 'generated/google/apis/genomics_v1/service.rb', line 1293

def get_reference_set(reference_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/referencesets/{referenceSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::ReferenceSet::Representation
  command.response_class = Google::Apis::GenomicsV1::ReferenceSet
  command.params['referenceSetId'] = reference_set_id unless reference_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_variant(variant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Variant

Gets a variant by ID. For the definitions of variants and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_id (String)

    The ID of the variant.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1624
1625
1626
1627
1628
1629
1630
1631
1632
# File 'generated/google/apis/genomics_v1/service.rb', line 1624

def get_variant(variant_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/variants/{variantId}', options)
  command.response_representation = Google::Apis::GenomicsV1::Variant::Representation
  command.response_class = Google::Apis::GenomicsV1::Variant
  command.params['variantId'] = variant_id unless variant_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::VariantSet

Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_set_id (String)

    Required. The ID of the variant set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1812
1813
1814
1815
1816
1817
1818
1819
1820
# File 'generated/google/apis/genomics_v1/service.rb', line 1812

def get_variantset(variant_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/variantsets/{variantSetId}', options)
  command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation
  command.response_class = Google::Apis::GenomicsV1::VariantSet
  command.params['variantSetId'] = variant_set_id unless variant_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_read_group_sets(import_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Operation

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 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 ( also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)

Parameters:

  • import_read_group_sets_request_object (Google::Apis::GenomicsV1::ImportReadGroupSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


899
900
901
902
903
904
905
906
907
908
# File 'generated/google/apis/genomics_v1/service.rb', line 899

def import_read_group_sets(import_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/readgroupsets:import', options)
  command.request_representation = Google::Apis::GenomicsV1::ImportReadGroupSetsRequest::Representation
  command.request_object = import_read_group_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_variants(import_variants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Operation

Creates variant data by asynchronously importing the provided information. For the definitions of variant sets and other genomics resources, see 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 as specified in infoMergeConfig. 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.

Parameters:

  • import_variants_request_object (Google::Apis::GenomicsV1::ImportVariantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'generated/google/apis/genomics_v1/service.rb', line 1452

def import_variants(import_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variants:import', options)
  command.request_representation = Google::Apis::GenomicsV1::ImportVariantsRequest::Representation
  command.request_object = import_variants_request_object
  command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_coverage_buckets(read_group_set_id, reference_name: nil, start: nil, end_: nil, target_bucket_width: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ListCoverageBucketsResponse

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 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.

Parameters:

  • read_group_set_id (String)

    Required. The ID of the read group set over which coverage is requested.

  • reference_name (String) (defaults to: nil)

    The name of the reference to query, within the reference set associated with this query. Optional.

  • start (String) (defaults to: nil)

    The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified. Defaults to 0.

  • end_ (String) (defaults to: nil)

    The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified. If unset or 0, defaults to the length of the reference.

  • target_bucket_width (String) (defaults to: nil)

    The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.

  • page_token (String) (defaults to: nil)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'generated/google/apis/genomics_v1/service.rb', line 1142

def list_coverage_buckets(read_group_set_id, reference_name: nil, start: nil, end_: nil, target_bucket_width: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/readgroupsets/{readGroupSetId}/coveragebuckets', options)
  command.response_representation = Google::Apis::GenomicsV1::ListCoverageBucketsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::ListCoverageBucketsResponse
  command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil?
  command.query['referenceName'] = reference_name unless reference_name.nil?
  command.query['start'] = start unless start.nil?
  command.query['end'] = end_ unless end_.nil?
  command.query['targetBucketWidth'] = target_bucket_width unless target_bucket_width.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_datasets(project_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ListDatasetsResponse

Lists datasets within a project. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • project_id (String) (defaults to: nil)

    Required. The Google Cloud project ID to list datasets for.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.

  • page_token (String) (defaults to: nil)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


458
459
460
461
462
463
464
465
466
467
468
# File 'generated/google/apis/genomics_v1/service.rb', line 458

def list_datasets(project_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/datasets', options)
  command.response_representation = Google::Apis::GenomicsV1::ListDatasetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::ListDatasetsResponse
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters:

  • name (String)

    The name of the operation collection.

  • filter (String) (defaults to: nil)

    A string for filtering Operations. 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 = 1432140000 * projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


790
791
792
793
794
795
796
797
798
799
800
801
# File 'generated/google/apis/genomics_v1/service.rb', line 790

def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::GenomicsV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_reference_bases(reference_id, start_position: nil, end_position: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ListBasesResponse

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 Implements GlobalAllianceApi.getReferenceBases.

Parameters:

  • reference_id (String)

    The ID of the reference.

  • start_position (String) (defaults to: nil)

    The start position (0-based) of this query. Defaults to 0.

  • end_position (String) (defaults to: nil)

    The end position (0-based, exclusive) of this query. Defaults to the length of this reference.

  • page_token (String) (defaults to: nil)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
# File 'generated/google/apis/genomics_v1/service.rb', line 1408

def list_reference_bases(reference_id, start_position: nil, end_position: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/references/{referenceId}/bases', options)
  command.response_representation = Google::Apis::GenomicsV1::ListBasesResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::ListBasesResponse
  command.params['referenceId'] = reference_id unless reference_id.nil?
  command.query['start'] = start_position unless start_position.nil?
  command.query['end'] = end_position unless end_position.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#merge_variants(merge_variants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Empty

Merges the given variants with existing variants. For the definitions of variants and other genomics resources, see 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 is added to the existing variant. Variant info fields are merged as specified in the infoMergeConfig field of the MergeVariantsRequest. Please exercise caution when using this method! It is easy to introduce mistakes in existing variants and difficult to back out of them. For example, suppose you were trying to merge a new variant with an existing one and both variants contain calls that belong to callsets with the same callset ID. // Existing variant - irrelevant fields trimmed for clarity "variantSetId": "10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], "calls": [ "callSetId": " 10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 0, 1 ], ] // New variant with conflicting call information "variantSetId": " 10473108253681171589", "referenceName": "1", "start": "10582", "referenceBases" : "G", "alternateBases": [ "A" ], "calls": [ "callSetId": " 10473108253681171589-0", "callSetName": "CALLSET0", "genotype": [ 1, 1 ], ] The resulting merged variant would overwrite the existing calls with those from the new variant: "variantSetId": "10473108253681171589", "referenceName" : "1", "start": "10582", "referenceBases": "G", "alternateBases": [ "A" ], " calls": [ "callSetId": "10473108253681171589-0", "callSetName": "CALLSET0", " genotype": [ 1, 1 ], ] This may be the desired outcome, but it is up to the user to determine if if that is indeed the case.

Parameters:

  • merge_variants_request_object (Google::Apis::GenomicsV1::MergeVariantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
# File 'generated/google/apis/genomics_v1/service.rb', line 1678

def merge_variants(merge_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variants:merge', options)
  command.request_representation = Google::Apis::GenomicsV1::MergeVariantsRequest::Representation
  command.request_object = merge_variants_request_object
  command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV1::Empty
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_call_set(call_set_id, call_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::CallSet

Updates a call set. For the definitions of call sets and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics.

Parameters:

  • call_set_id (String)

    The ID of the call set to be updated.

  • call_set_object (Google::Apis::GenomicsV1::CallSet) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'generated/google/apis/genomics_v1/service.rb', line 2022

def patch_call_set(call_set_id, call_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/callsets/{callSetId}', options)
  command.request_representation = Google::Apis::GenomicsV1::CallSet::Representation
  command.request_object = call_set_object
  command.response_representation = Google::Apis::GenomicsV1::CallSet::Representation
  command.response_class = Google::Apis::GenomicsV1::CallSet
  command.params['callSetId'] = call_set_id unless call_set_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_dataset(dataset_id, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Dataset

Updates a dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics.

Parameters:

  • dataset_id (String)

    The ID of the dataset to be updated.

  • dataset_object (Google::Apis::GenomicsV1::Dataset) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


561
562
563
564
565
566
567
568
569
570
571
572
# File 'generated/google/apis/genomics_v1/service.rb', line 561

def patch_dataset(dataset_id, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/datasets/{datasetId}', options)
  command.request_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.request_object = dataset_object
  command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.response_class = Google::Apis::GenomicsV1::Dataset
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_read_group_set(read_group_set_id, read_group_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::ReadGroupSet

Updates a read group set. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics.

Parameters:

  • read_group_set_id (String)

    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.

  • read_group_set_object (Google::Apis::GenomicsV1::ReadGroupSet) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    An optional mask specifying which fields to update. Supported fields: * name. * referenceSetId. Leaving updateMask unset is equivalent to specifying all mutable fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
# File 'generated/google/apis/genomics_v1/service.rb', line 1012

def patch_read_group_set(read_group_set_id, read_group_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/readgroupsets/{readGroupSetId}', options)
  command.request_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation
  command.request_object = read_group_set_object
  command.response_representation = Google::Apis::GenomicsV1::ReadGroupSet::Representation
  command.response_class = Google::Apis::GenomicsV1::ReadGroupSet
  command.params['readGroupSetId'] = read_group_set_id unless read_group_set_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_variant(variant_id, variant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Variant

Updates a variant. For the definitions of variants and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics. Returns the modified variant without its calls.

Parameters:

  • variant_id (String)

    The ID of the variant to be updated.

  • variant_object (Google::Apis::GenomicsV1::Variant) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
# File 'generated/google/apis/genomics_v1/service.rb', line 1557

def patch_variant(variant_id, variant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/variants/{variantId}', options)
  command.request_representation = Google::Apis::GenomicsV1::Variant::Representation
  command.request_object = variant_object
  command.response_representation = Google::Apis::GenomicsV1::Variant::Representation
  command.response_class = Google::Apis::GenomicsV1::Variant
  command.params['variantId'] = variant_id unless variant_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_variantset(variant_set_id, variant_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::VariantSet

Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • variant_set_id (String)

    The ID of the variant to be updated (must already exist).

  • variant_set_object (Google::Apis::GenomicsV1::VariantSet) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    An optional mask specifying which fields to update. Supported fields: * metadata. * name. * description. Leaving updateMask unset is equivalent to specifying all mutable fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
# File 'generated/google/apis/genomics_v1/service.rb', line 1916

def patch_variantset(variant_set_id, variant_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/variantsets/{variantSetId}', options)
  command.request_representation = Google::Apis::GenomicsV1::VariantSet::Representation
  command.request_object = variant_set_object
  command.response_representation = Google::Apis::GenomicsV1::VariantSet::Representation
  command.response_class = Google::Apis::GenomicsV1::VariantSet
  command.params['variantSetId'] = variant_set_id unless variant_set_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_annotations(search_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchAnnotationsResponse

Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.

Parameters:

  • search_annotations_request_object (Google::Apis::GenomicsV1::SearchAnnotationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


418
419
420
421
422
423
424
425
426
427
# File 'generated/google/apis/genomics_v1/service.rb', line 418

def search_annotations(search_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/annotations/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchAnnotationsRequest::Representation
  command.request_object = search_annotations_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchAnnotationsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchAnnotationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_annotationset_annotation_sets(search_annotation_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchAnnotationSetsResponse

Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

Parameters:

  • search_annotation_sets_request_object (Google::Apis::GenomicsV1::SearchAnnotationSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


206
207
208
209
210
211
212
213
214
215
# File 'generated/google/apis/genomics_v1/service.rb', line 206

def search_annotationset_annotation_sets(search_annotation_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/annotationsets/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchAnnotationSetsRequest::Representation
  command.request_object = search_annotation_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchAnnotationSetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchAnnotationSetsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_call_sets(search_call_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchCallSetsResponse

Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchCallSets.

Parameters:

  • search_call_sets_request_object (Google::Apis::GenomicsV1::SearchCallSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'generated/google/apis/genomics_v1/service.rb', line 1952

def search_call_sets(search_call_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/callsets/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchCallSetsRequest::Representation
  command.request_object = search_call_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchCallSetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchCallSetsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_read_group_sets(search_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchReadGroupSetsResponse

Searches for read group sets matching the criteria. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchReadGroupSets.

Parameters:

  • search_read_group_sets_request_object (Google::Apis::GenomicsV1::SearchReadGroupSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


972
973
974
975
976
977
978
979
980
981
# File 'generated/google/apis/genomics_v1/service.rb', line 972

def search_read_group_sets(search_read_group_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/readgroupsets/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchReadGroupSetsRequest::Representation
  command.request_object = search_read_group_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchReadGroupSetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchReadGroupSetsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_reads(search_reads_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchReadsResponse

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 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 specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield reads in the same order across their respective streams of paginated responses. Implements GlobalAllianceApi. searchReads.

Parameters:

  • search_reads_request_object (Google::Apis::GenomicsV1::SearchReadsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'generated/google/apis/genomics_v1/service.rb', line 1192

def search_reads(search_reads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/reads/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchReadsRequest::Representation
  command.request_object = search_reads_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchReadsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchReadsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_reference_sets(search_reference_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchReferenceSetsResponse

Searches for reference sets which match the given criteria. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchReferenceSets

Parameters:

  • search_reference_sets_request_object (Google::Apis::GenomicsV1::SearchReferenceSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
# File 'generated/google/apis/genomics_v1/service.rb', line 1258

def search_reference_sets(search_reference_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/referencesets/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchReferenceSetsRequest::Representation
  command.request_object = search_reference_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchReferenceSetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchReferenceSetsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_references(search_references_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchReferencesResponse

Searches for references which match the given criteria. For the definitions of references and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchReferences.

Parameters:

  • search_references_request_object (Google::Apis::GenomicsV1::SearchReferencesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
# File 'generated/google/apis/genomics_v1/service.rb', line 1326

def search_references(search_references_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/references/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchReferencesRequest::Representation
  command.request_object = search_references_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchReferencesResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchReferencesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_variant_sets(search_variant_sets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchVariantSetsResponse

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 Implements GlobalAllianceApi.searchVariantSets.

Parameters:

  • search_variant_sets_request_object (Google::Apis::GenomicsV1::SearchVariantSetsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
# File 'generated/google/apis/genomics_v1/service.rb', line 1845

def search_variant_sets(search_variant_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variantsets/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchVariantSetsRequest::Representation
  command.request_object = search_variant_sets_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchVariantSetsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchVariantSetsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_variants(search_variants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::SearchVariantsResponse

Gets a list of variants matching the criteria. For the definitions of variants and other genomics resources, see Fundamentals of Google Genomics Implements GlobalAllianceApi.searchVariants.

Parameters:

  • search_variants_request_object (Google::Apis::GenomicsV1::SearchVariantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'generated/google/apis/genomics_v1/service.rb', line 1486

def search_variants(search_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variants/search', options)
  command.request_representation = Google::Apis::GenomicsV1::SearchVariantsRequest::Representation
  command.request_object = search_variants_request_object
  command.response_representation = Google::Apis::GenomicsV1::SearchVariantsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::SearchVariantsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Policy

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 See Setting a Policy for more information.

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being specified. Format is datasets/.

  • set_iam_policy_request_object (Google::Apis::GenomicsV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


671
672
673
674
675
676
677
678
679
680
681
# File 'generated/google/apis/genomics_v1/service.rb', line 671

def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::GenomicsV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::GenomicsV1::Policy::Representation
  command.response_class = Google::Apis::GenomicsV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_reads(stream_reads_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::StreamReadsResponse

Returns a stream of all the reads matching the search request, ordered by reference name, position, and ID.

Parameters:

  • stream_reads_request_object (Google::Apis::GenomicsV1::StreamReadsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
# File 'generated/google/apis/genomics_v1/service.rb', line 1223

def stream_reads(stream_reads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/reads:stream', options)
  command.request_representation = Google::Apis::GenomicsV1::StreamReadsRequest::Representation
  command.request_object = stream_reads_request_object
  command.response_representation = Google::Apis::GenomicsV1::StreamReadsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::StreamReadsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_variants(stream_variants_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::StreamVariantsResponse

Returns a stream of all the variants matching the search request, ordered by reference name, position, and ID.

Parameters:

  • stream_variants_request_object (Google::Apis::GenomicsV1::StreamVariantsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'generated/google/apis/genomics_v1/service.rb', line 1709

def stream_variants(stream_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/variants:stream', options)
  command.request_representation = Google::Apis::GenomicsV1::StreamVariantsRequest::Representation
  command.request_object = stream_variants_request_object
  command.response_representation = Google::Apis::GenomicsV1::StreamVariantsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::StreamVariantsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. See Testing Permissions for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being specified. Format is datasets/.

  • test_iam_permissions_request_object (Google::Apis::GenomicsV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


746
747
748
749
750
751
752
753
754
755
756
# File 'generated/google/apis/genomics_v1/service.rb', line 746

def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::GenomicsV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::GenomicsV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::GenomicsV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undelete_dataset(dataset_id, undelete_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Dataset

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 This operation is only possible for a week after the deletion occurred.

Parameters:

  • dataset_id (String)

    The ID of the dataset to be undeleted.

  • undelete_dataset_request_object (Google::Apis::GenomicsV1::UndeleteDatasetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


634
635
636
637
638
639
640
641
642
643
644
# File 'generated/google/apis/genomics_v1/service.rb', line 634

def undelete_dataset(dataset_id, undelete_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/datasets/{datasetId}:undelete', options)
  command.request_representation = Google::Apis::GenomicsV1::UndeleteDatasetRequest::Representation
  command.request_object = undelete_dataset_request_object
  command.response_representation = Google::Apis::GenomicsV1::Dataset::Representation
  command.response_class = Google::Apis::GenomicsV1::Dataset
  command.params['datasetId'] = dataset_id unless dataset_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_annotation(annotation_id, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::Annotation

Updates an annotation. Caller must have WRITE permission for the associated dataset.

Parameters:

  • annotation_id (String)

    The ID of the annotation to be updated.

  • annotation_object (Google::Apis::GenomicsV1::Annotation) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    An optional mask specifying which fields to update. Mutable fields are name, variant, transcript, and info. If unspecified, all mutable fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


349
350
351
352
353
354
355
356
357
358
359
360
# File 'generated/google/apis/genomics_v1/service.rb', line 349

def update_annotation(annotation_id, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/annotations/{annotationId}', options)
  command.request_representation = Google::Apis::GenomicsV1::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::GenomicsV1::Annotation::Representation
  command.response_class = Google::Apis::GenomicsV1::Annotation
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_annotationset(annotation_set_id, annotation_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV1::AnnotationSet

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

Parameters:

  • annotation_set_id (String)

    The ID of the annotation set to be updated.

  • annotation_set_object (Google::Apis::GenomicsV1::AnnotationSet) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    An optional mask specifying which fields to update. Mutable fields are name, source_uri, and info. If unspecified, all mutable fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


139
140
141
142
143
144
145
146
147
148
149
150
# File 'generated/google/apis/genomics_v1/service.rb', line 139

def update_annotationset(annotation_set_id, annotation_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/annotationsets/{annotationSetId}', options)
  command.request_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation
  command.request_object = annotation_set_object
  command.response_representation = Google::Apis::GenomicsV1::AnnotationSet::Representation
  command.response_class = Google::Apis::GenomicsV1::AnnotationSet
  command.params['annotationSetId'] = annotation_set_id unless annotation_set_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end