Class: Google::Apis::GenomicsV1::StreamReadsRequest

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 stream reads 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) ⇒ StreamReadsRequest

Returns a new instance of StreamReadsRequest.


2085
2086
2087
# File 'generated/google/apis/genomics_v1/classes.rb', line 2085

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

Instance Attribute Details

#endString

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)

2059
2060
2061
# File 'generated/google/apis/genomics_v1/classes.rb', line 2059

def end
  @end
end

#project_idString

The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required. Corresponds to the JSON property projectId

Returns:

  • (String)

2036
2037
2038
# File 'generated/google/apis/genomics_v1/classes.rb', line 2036

def project_id
  @project_id
end

#read_group_set_idString

The ID of the read group set from which to stream reads. Corresponds to the JSON property readGroupSetId

Returns:

  • (String)

2041
2042
2043
# File 'generated/google/apis/genomics_v1/classes.rb', line 2041

def read_group_set_id
  @read_group_set_id
end

#reference_nameString

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)

2047
2048
2049
# File 'generated/google/apis/genomics_v1/classes.rb', line 2047

def reference_name
  @reference_name
end

#shardFixnum

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

Returns:

  • (Fixnum)

2068
2069
2070
# File 'generated/google/apis/genomics_v1/classes.rb', line 2068

def shard
  @shard
end

#startString

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)

2053
2054
2055
# File 'generated/google/apis/genomics_v1/classes.rb', line 2053

def start
  @start
end

#total_shardsFixnum

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 shards 4 and 5 of 10 totalShards. This property can be leveraged for adaptive retries. Corresponds to the JSON property totalShards

Returns:

  • (Fixnum)

2083
2084
2085
# File 'generated/google/apis/genomics_v1/classes.rb', line 2083

def total_shards
  @total_shards
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2090
2091
2092
2093
2094
2095
2096
2097
2098
# File 'generated/google/apis/genomics_v1/classes.rb', line 2090

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