Struct gapi_grpc::google::analytics::admin::v1alpha::CustomMetric

pub struct CustomMetric {
    pub name: String,
    pub parameter_name: String,
    pub display_name: String,
    pub description: String,
    pub measurement_unit: i32,
    pub scope: i32,
}

A definition for a custom metric.

Fields

name: String

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

parameter_name: String

Required. Immutable. Tagging name for this custom metric.

If this is an event-scoped metric, then this is the event parameter name.

May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

display_name: String

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

description: String

Optional. Description for this custom dimension. Max length of 150 characters.

measurement_unit: i32

Required. Immutable. The type for the custom metric’s value.

scope: i32

Required. Immutable. The scope of this custom metric.

Implementations

impl CustomMetric

pub fn measurement_unit(&self) -> MeasurementUnit

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

pub fn set_measurement_unit(&mut self, value: MeasurementUnit)

Sets measurement_unit to the provided enum value.

pub fn scope(&self) -> MetricScope

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

pub fn set_scope(&mut self, value: MetricScope)

Sets scope to the provided enum value.

Trait Implementations

impl Clone for CustomMetric

fn clone(&self) -> CustomMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomMetric

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

Formats the value using the given formatter.

impl Default for CustomMetric

fn default() -> CustomMetric

Returns the “default value” for a type.

impl Message for CustomMetric

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

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

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

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

This method tests for !=.

impl StructuralPartialEq for CustomMetric