Class: Google::Apis::GenomicsV1beta2::SearchVariantsRequest

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

Overview

The variant search request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchVariantsRequest

Returns a new instance of SearchVariantsRequest.



2887
2888
2889
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2887

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. Currently, variants with no calls from any call set will never be returned. Corresponds to the JSON property callSetIds

Returns:

  • (Array<String>) 


2837
2838
2839
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2837

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) 


2843
2844
2845
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2843

def end
  @end
end

#max_calls ⇒ Fixnum

The maximum number of calls to return. However, at least one variant will always be returned, even if it has more calls than this limit. If unspecified, defaults to 5000. Corresponds to the JSON property maxCalls

Returns:

  • (Fixnum) 


2850
2851
2852
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2850

def max_calls
  @max_calls
end

#page_size ⇒ Fixnum

The maximum number of variants to return. If unspecified, defaults to 5000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


2855
2856
2857
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2855

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) 


2862
2863
2864
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2862

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) 


2867
2868
2869
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2867

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) 


2873
2874
2875
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2873

def start
  @start
end

#variant_name ⇒ String

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

Returns:

  • (String) 


2878
2879
2880
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2878

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


2885
2886
2887
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2885

def variant_set_ids
  @variant_set_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2892

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