class Google::Apis::GenomicsV1beta2::SearchVariantsRequest

The variant search request.

Attributes

call_set_ids[RW]

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` @return [Array<String>]

end[RW]

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` @return [String]

max_calls[RW]

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` @return [Fixnum]

page_size[RW]

The maximum number of variants to return. If unspecified, defaults to 5000. Corresponds to the JSON property `pageSize` @return [Fixnum]

page_token[RW]

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` @return [String]

reference_name[RW]

Required. Only return variants in this reference sequence. Corresponds to the JSON property `referenceName` @return [String]

start[RW]

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` @return [String]

variant_name[RW]

Only return variants which have exactly this name. Corresponds to the JSON property `variantName` @return [String]

variant_set_ids[RW]

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` @return [Array<String>]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/genomics_v1beta2/classes.rb, line 2887
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# 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