Struct google_api_proto::google::genomics::v1::StreamReadsRequest

pub struct StreamReadsRequest {
    pub project_id: String,
    pub read_group_set_id: String,
    pub reference_name: String,
    pub start: i64,
    pub end: i64,
    pub shard: i32,
    pub total_shards: i32,
}

The stream reads request.

Fields

project_id: String

The Google Cloud project ID which will be billed for this access. The caller must have WRITE access to this project. Required.

read_group_set_id: String

The ID of the read group set from which to stream reads.

reference_name: String

The reference sequence name, for example chr1, 1, or chrX. If set to *, only unmapped reads are returned.

start: i64

The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified.

end: i64

The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified.

shard: i32

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

total_shards: i32

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.

Trait Implementations

impl Clone for StreamReadsRequest

fn clone(&self) -> StreamReadsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamReadsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamReadsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for StreamReadsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StreamReadsRequest

fn eq(&self, other: &StreamReadsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamReadsRequest