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.


2826
2827
2828
# File 'generated/google/apis/genomics_v1/classes.rb', line 2826

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

Instance Attribute Details

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

2786
2787
2788
# File 'generated/google/apis/genomics_v1/classes.rb', line 2786

def call_set_ids
  @call_set_ids
end

#endString

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)

2803
2804
2805
# File 'generated/google/apis/genomics_v1/classes.rb', line 2803

def end
  @end
end

#max_callsFixnum

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)

2824
2825
2826
# File 'generated/google/apis/genomics_v1/classes.rb', line 2824

def max_calls
  @max_calls
end

#page_sizeFixnum

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)

2816
2817
2818
# File 'generated/google/apis/genomics_v1/classes.rb', line 2816

def page_size
  @page_size
end

#page_tokenString

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)

2810
2811
2812
# File 'generated/google/apis/genomics_v1/classes.rb', line 2810

def page_token
  @page_token
end

#reference_nameString

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

Returns:

  • (String)

2791
2792
2793
# File 'generated/google/apis/genomics_v1/classes.rb', line 2791

def reference_name
  @reference_name
end

#startString

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)

2797
2798
2799
# File 'generated/google/apis/genomics_v1/classes.rb', line 2797

def start
  @start
end

#variant_nameString

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

Returns:

  • (String)

2779
2780
2781
# File 'generated/google/apis/genomics_v1/classes.rb', line 2779

def variant_name
  @variant_name
end

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

2774
2775
2776
# File 'generated/google/apis/genomics_v1/classes.rb', line 2774

def variant_set_ids
  @variant_set_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
# File 'generated/google/apis/genomics_v1/classes.rb', line 2831

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