Struct gapi_grpc::google::genomics::v1::SearchReadsRequest

pub struct SearchReadsRequest {
    pub read_group_set_ids: Vec<String>,
    pub read_group_ids: Vec<String>,
    pub reference_name: String,
    pub start: i64,
    pub end: i64,
    pub page_token: String,
    pub page_size: i32,
}

The read search request.

Fields

read_group_set_ids: Vec<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.

read_group_ids: Vec<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.

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.

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.

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.

page_size: i32

The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.

Trait Implementations

impl Clone for SearchReadsRequest

fn clone(&self) -> SearchReadsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchReadsRequest

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

Formats the value using the given formatter.

impl Default for SearchReadsRequest

fn default() -> SearchReadsRequest

Returns the “default value” for a type.

impl Message for SearchReadsRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<SearchReadsRequest> for SearchReadsRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for SearchReadsRequest