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



1210
1211
1212
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1210

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) 


1174
1175
1176
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1174

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) 


1187
1188
1189
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1187

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) 


1181
1182
1183
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1181

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


1168
1169
1170
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1168

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


1208
1209
1210
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1208

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) 


1200
1201
1202
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1200

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) 


1193
1194
1195
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1193

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1215

def update!(**args)
  @read_group_ids = args[:read_group_ids] if args.key?(:read_group_ids)
  @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)
  @start = args[:start] if args.key?(:start)
  @reference_name = args[:reference_name] if args.key?(:reference_name)
  @read_group_set_ids = args[:read_group_set_ids] if args.key?(:read_group_set_ids)
end