class Google::Apis::GenomicsV1::StreamReadsRequest

The stream reads 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]

project_id[RW]

The Google Developers Console project ID or number which will be billed for this access. The caller must have WRITE access to this project. Required. Corresponds to the JSON property `projectId` @return [String]

read_group_set_id[RW]

The ID of the read group set from which to stream reads. Corresponds to the JSON property `readGroupSetId` @return [String]

reference_name[RW]

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

shard[RW]

Restricts results to a shard containing approximately `1/totalShards` of the normal response payload for this query. Results from a sharded request are disjoint from those returned by all queries which differ only in their shard parameter. A shard may yield 0 results; this is especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`. Corresponds to the JSON property `shard` @return [Fixnum]

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]

total_shards[RW]

Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned for each query with a unique `shard` parameter specified. A best effort is made to yield equally sized shards. Sharding can be used to distribute processing amongst workers, where each worker is assigned a unique `shard` number and all workers specify the same `totalShards` number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to those returned by a single unsharded query. Queries for different values of `totalShards` with common divisors will share shard boundaries. For example, streaming `shard` 2 of 5 `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This property can be leveraged for adaptive retries. Corresponds to the JSON property `totalShards` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/genomics_v1/classes.rb, line 2073
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 2078
def update!(**args)
  @project_id = args[:project_id] if args.key?(:project_id)
  @read_group_set_id = args[:read_group_set_id] if args.key?(:read_group_set_id)
  @reference_name = args[:reference_name] if args.key?(:reference_name)
  @start = args[:start] if args.key?(:start)
  @end = args[:end] if args.key?(:end)
  @shard = args[:shard] if args.key?(:shard)
  @total_shards = args[:total_shards] if args.key?(:total_shards)
end