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



2099
2100
2101
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2099

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


2081
2082
2083
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2081

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) 


2053
2054
2055
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2053

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) 


2061
2062
2063
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2061

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) 


2074
2075
2076
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2074

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) 


2068
2069
2070
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2068

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) 


2097
2098
2099
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2097

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) 


2087
2088
2089
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2087

def start
  @start
end

#variant_name ⇒ String

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

Returns:

  • (String) 


2092
2093
2094
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2092

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


2047
2048
2049
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2047

def variant_set_ids
  @variant_set_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2104

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