Struct google_api_proto::google::genomics::v1::ListCoverageBucketsRequest

pub struct ListCoverageBucketsRequest {
    pub read_group_set_id: String,
    pub reference_name: String,
    pub start: i64,
    pub end: i64,
    pub target_bucket_width: i64,
    pub page_token: String,
    pub page_size: i32,
}

Fields

read_group_set_id: String

Required. The ID of the read group set over which coverage is requested.

reference_name: String

The name of the reference to query, within the reference set associated with this query. Optional.

start: i64

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

end: i64

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

target_bucket_width: i64

The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.

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 1024. The maximum value is 2048.

Trait Implementations

impl Clone for ListCoverageBucketsRequest

fn clone(&self) -> ListCoverageBucketsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListCoverageBucketsRequest

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

Formats the value using the given formatter.

impl Default for ListCoverageBucketsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListCoverageBucketsRequest

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 ListCoverageBucketsRequest

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