Struct google_genomics1::SearchReadsRequest

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

The read search request.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• search reads (request)

Fields

page_token: Option<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.

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

page_size: Option<i32>

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

start: Option<String>

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

end: Option<String>

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

reference_name: Option<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.

Trait Implementations

impl Default for SearchReadsRequest

fn default() -> SearchReadsRequest

Returns the "default value" for a type.

impl Clone for SearchReadsRequest

fn clone(&self) -> SearchReadsRequest

Returns a copy of the value.

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 RequestValue for SearchReadsRequest