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



3026
3027
3028
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3026

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


2974
2975
2976
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2974

def call_set_ids
  @call_set_ids
end

#end ⇒ Fixnum

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:

  • (Fixnum) 


2980
2981
2982
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2980

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) 


2988
2989
2990
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2988

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) 


2994
2995
2996
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2994

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) 


3001
3002
3003
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3001

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) 


3006
3007
3008
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3006

def reference_name
  @reference_name
end

#start ⇒ Fixnum

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:

  • (Fixnum) 


3012
3013
3014
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3012

def start
  @start
end

#variant_name ⇒ String

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

Returns:

  • (String) 


3017
3018
3019
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3017

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


3024
3025
3026
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3024

def variant_set_ids
  @variant_set_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3031

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