Class: Google::Apis::GenomicsV1::SearchVariantsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/genomics_v1/classes.rb,
generated/google/apis/genomics_v1/representations.rb,
generated/google/apis/genomics_v1/representations.rb

Overview

The variant search request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchVariantsRequest

Returns a new instance of SearchVariantsRequest



1575
1576
1577
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1575

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#call_set_ids ⇒ Array<String>

Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all. Corresponds to the JSON property callSetIds

Returns:

  • (Array<String>) 


1557
1558
1559
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1557

def call_set_ids
  @call_set_ids
end

#end ⇒ String

The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference. Corresponds to the JSON property end

Returns:

  • (String) 


1529
1530
1531
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1529

def end
  @end
end

#max_calls ⇒ Fixnum

The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000. Corresponds to the JSON property maxCalls

Returns:

  • (Fixnum) 


1544
1545
1546
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1544

def max_calls
  @max_calls
end

#page_size ⇒ Fixnum

The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1550
1551
1552
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1550

def page_size
  @page_size
end

#page_token ⇒ String

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. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1536
1537
1538
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1536

def page_token
  @page_token
end

#reference_name ⇒ String

Required. Only return variants in this reference sequence. Corresponds to the JSON property referenceName

Returns:

  • (String) 


1573
1574
1575
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1573

def reference_name
  @reference_name
end

#start ⇒ String

The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0. Corresponds to the JSON property start

Returns:

  • (String) 


1568
1569
1570
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1568

def start
  @start
end

#variant_name ⇒ String

Only return variants which have exactly this name. Corresponds to the JSON property variantName

Returns:

  • (String) 


1562
1563
1564
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1562

def variant_name
  @variant_name
end

#variant_set_ids ⇒ Array<String>

At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request. Corresponds to the JSON property variantSetIds

Returns:

  • (Array<String>) 


1523
1524
1525
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1523

def variant_set_ids
  @variant_set_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1580

def update!(**args)
  @variant_set_ids = args[:variant_set_ids] if args.key?(:variant_set_ids)
  @end = args[:end] if args.key?(:end)
  @page_token = args[:page_token] if args.key?(:page_token)
  @max_calls = args[:max_calls] if args.key?(:max_calls)
  @page_size = args[:page_size] if args.key?(:page_size)
  @call_set_ids = args[:call_set_ids] if args.key?(:call_set_ids)
  @variant_name = args[:variant_name] if args.key?(:variant_name)
  @start = args[:start] if args.key?(:start)
  @reference_name = args[:reference_name] if args.key?(:reference_name)
end