Struct google_api_proto::google::genomics::v1::SearchVariantsRequest

pub struct SearchVariantsRequest {
    pub variant_set_ids: Vec<String>,
    pub variant_name: String,
    pub call_set_ids: Vec<String>,
    pub reference_name: String,
    pub start: i64,
    pub end: i64,
    pub page_token: String,
    pub page_size: i32,
    pub max_calls: i32,
}

The variant search request.

Fields

variant_set_ids: Vec<String>

At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request.

variant_name: String

Only return variants which have exactly this name.

call_set_ids: Vec<String>

Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won’t be returned at all.

reference_name: String

Required. Only return variants in this reference sequence.

start: i64

The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0.

end: i64

The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference.

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 variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000.

max_calls: i32

The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000.

Trait Implementations

impl Clone for SearchVariantsRequest

fn clone(&self) -> SearchVariantsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchVariantsRequest

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

Formats the value using the given formatter.

impl Default for SearchVariantsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchVariantsRequest

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 SearchVariantsRequest

fn eq(&self, other: &SearchVariantsRequest) -> 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 SearchVariantsRequest