class Google::Apis::GenomicsV1::SearchReadsRequest

The read search request.

Attributes

end[RW]

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

page_size[RW]

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` @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]

read_group_ids[RW]

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

read_group_set_ids[RW]

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

reference_name[RW]

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

start[RW]

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

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/genomics_v1/classes.rb, line 1672
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_v1/classes.rb, line 1677
def update!(**args)
  @read_group_set_ids = args[:read_group_set_ids] if args.key?(:read_group_set_ids)
  @read_group_ids = args[:read_group_ids] if args.key?(:read_group_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)
end