Class: Google::Apis::GenomicsV1::SearchVariantsRequest
- Inherits:
-
Object
- Object
- Google::Apis::GenomicsV1::SearchVariantsRequest
- 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
-
#call_set_ids ⇒ Array<String>
Only return variant calls which belong to call sets with these ids.
-
#end ⇒ Fixnum
The end of the window, 0-based exclusive.
-
#max_calls ⇒ Fixnum
The maximum number of calls to return in a single page.
-
#page_size ⇒ Fixnum
The maximum number of variants to return in a single page.
-
#page_token ⇒ String
The continuation token, which is used to page through large result sets.
-
#reference_name ⇒ String
Required.
-
#start ⇒ Fixnum
The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.
-
#variant_name ⇒ String
Only return variants which have exactly this name.
-
#variant_set_ids ⇒ Array<String>
At most one variant set ID must be provided.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SearchVariantsRequest
constructor
A new instance of SearchVariantsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SearchVariantsRequest
Returns a new instance of SearchVariantsRequest
3025 3026 3027 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3025 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
2973 2974 2975 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 2973 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
2979 2980 2981 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 2979 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
2987 2988 2989 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 2987 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
2993 2994 2995 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 2993 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
3000 3001 3002 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3000 def page_token @page_token end |
#reference_name ⇒ String
Required. Only return variants in this reference sequence.
Corresponds to the JSON property referenceName
3005 3006 3007 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3005 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
3011 3012 3013 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3011 def start @start end |
#variant_name ⇒ String
Only return variants which have exactly this name.
Corresponds to the JSON property variantName
3016 3017 3018 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3016 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
3023 3024 3025 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3023 def variant_set_ids @variant_set_ids end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 |
# File 'generated/google/apis/genomics_v1/classes.rb', line 3030 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 |