Struct gapi_grpc::google::analytics::data::v1beta::MetricMetadata

pub struct MetricMetadata {
    pub api_name: String,
    pub ui_name: String,
    pub description: String,
    pub deprecated_api_names: Vec<String>,
    pub type: i32,
    pub expression: String,
    pub custom_definition: bool,
}

Explains a metric.

Fields

api_name: String

A metric name. Useable in Metric’s name. For example, eventCount.

ui_name: String

This metric’s name within the Google Analytics user interface. For example, Event count.

description: String

Description of how this metric is used and calculated.

deprecated_api_names: Vec<String>

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

type: i32

The type of this metric.

expression: String

The mathematical expression for this derived metric. Can be used in Metric’s expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

custom_definition: bool

True if the metric is a custom metric for this property.

Implementations

impl MetricMetadata

pub fn type(&self) -> MetricType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: MetricType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for MetricMetadata

fn clone(&self) -> MetricMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricMetadata

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

Formats the value using the given formatter.

impl Default for MetricMetadata

fn default() -> MetricMetadata

Returns the “default value” for a type.

impl Message for MetricMetadata

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

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

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

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

This method tests for !=.

impl StructuralPartialEq for MetricMetadata