Class: Google::Apis::GenomicsV1::SearchReadsRequest

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 read 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) ⇒ SearchReadsRequest

Returns a new instance of SearchReadsRequest



2701
2702
2703
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2701

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

Instance Attribute Details

#end ⇒ Fixnum

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:

  • (Fixnum) 


2658
2659
2660
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2658

def end
  @end
end

#page_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2664
2665
2666
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2664

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) 


2671
2672
2673
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2671

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


2678
2679
2680
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2678

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


2686
2687
2688
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2686

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. If unspecified, all reads (mapped and unmapped) are returned. Corresponds to the JSON property referenceName

Returns:

  • (String) 


2693
2694
2695
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2693

def reference_name
  @reference_name
end

#start ⇒ Fixnum

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:

  • (Fixnum) 


2699
2700
2701
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2699

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2706
2707
2708
2709
2710
2711
2712
2713
2714
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2706

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