Struct gapi_grpc::google::analytics::data::v1alpha::Pivot

pub struct Pivot {
    pub field_names: Vec<String>,
    pub order_bys: Vec<OrderBy>,
    pub offset: i64,
    pub limit: i64,
    pub metric_aggregations: Vec<i32>,
}

Describes the visible dimension columns and rows in the report response.

Fields

field_names: Vec<String>

Dimension names for visible columns in the report response. Including “dateRange” produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

order_bys: Vec<OrderBy>

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

offset: i64

The row count of the start row. The first row is counted as row 0.

limit: i64

The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.

metric_aggregations: Vec<i32>

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

Implementations

impl Pivot

pub fn metric_aggregations(
    &self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<MetricAggregation>>

Returns an iterator which yields the valid enum values contained in metric_aggregations.

pub fn push_metric_aggregations(&mut self, value: MetricAggregation)

Appends the provided enum value to metric_aggregations.

Trait Implementations

impl Clone for Pivot

fn clone(&self) -> Pivot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pivot

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

Formats the value using the given formatter.

impl Default for Pivot

fn default() -> Pivot

Returns the “default value” for a type.

impl Message for Pivot

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<Pivot> for Pivot

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

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

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

This method tests for !=.

impl StructuralPartialEq for Pivot