Class: Google::Apis::GenomicsV1beta2::SearchReadsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/genomics_v1beta2/classes.rb,
generated/google/apis/genomics_v1beta2/representations.rb,
generated/google/apis/genomics_v1beta2/representations.rb

Overview

The read search request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchReadsRequest

Returns a new instance of SearchReadsRequest



2565
2566
2567
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2565

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

Instance Attribute Details

#end ⇒ String

The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified. Corresponds to the JSON property end

Returns:

  • (String) 


2523
2524
2525
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2523

def end
  @end
end

#page_size ⇒ Fixnum

Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


2529
2530
2531
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2529

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) 


2536
2537
2538
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2536

def page_token
  @page_token
end

#read_group_ids ⇒ Array<String>

The IDs of the read groups within which to search for reads. All specified read groups must belong to the same read group sets. Must specify one of readGroupSetIds or readGroupIds. Corresponds to the JSON property readGroupIds

Returns:

  • (Array<String>) 


2543
2544
2545
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2543

def read_group_ids
  @read_group_ids
end

#read_group_set_ids ⇒ Array<String>

The IDs of the read groups sets within which to search for reads. All specified read group sets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query. Must specify one of readGroupSetIds or readGroupIds. Corresponds to the JSON property readGroupSetIds

Returns:

  • (Array<String>) 


2551
2552
2553
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2551

def read_group_set_ids
  @read_group_set_ids
end

#reference_name ⇒ String

The reference sequence name, for example chr1, 1, or chrX. If set to *, only unmapped reads are returned. Corresponds to the JSON property referenceName

Returns:

  • (String) 


2557
2558
2559
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2557

def reference_name
  @reference_name
end

#start ⇒ String

The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified. Corresponds to the JSON property start

Returns:

  • (String) 


2563
2564
2565
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2563

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 2570

def update!(**args)
  @end = args[:end] unless args[:end].nil?
  @page_size = args[:page_size] unless args[:page_size].nil?
  @page_token = args[:page_token] unless args[:page_token].nil?
  @read_group_ids = args[:read_group_ids] unless args[:read_group_ids].nil?
  @read_group_set_ids = args[:read_group_set_ids] unless args[:read_group_set_ids].nil?
  @reference_name = args[:reference_name] unless args[:reference_name].nil?
  @start = args[:start] unless args[:start].nil?
end