Struct google_api_proto::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,
    pub restricted_metric_type: Vec<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. The type for the custom metric’s value.

scope: i32

Required. Immutable. The scope of this custom metric.

restricted_metric_type: Vec<i32>

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

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.

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

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

pub fn push_restricted_metric_type(&mut self, value: RestrictedMetricType)

Appends the provided enum value to restricted_metric_type.

Trait Implementations

impl Clone for CustomMetric

fn clone(&self) -> CustomMetric

Returns a copy of the value.

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() -> Self

Returns the “default value” for a type.

impl Message for CustomMetric

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 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: &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 CustomMetric