Struct MetricDescriptorMetadata

#[non_exhaustive]
pub struct MetricDescriptorMetadata {
    pub launch_stage: LaunchStage,
    pub sample_period: Option<Duration>,
    pub ingest_delay: Option<Duration>,
    pub time_series_resource_hierarchy_level: Vec<TimeSeriesResourceHierarchyLevel>,
}

Additional annotations that can be used to guide the usage of a metric.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

launch_stage: LaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period: Option<Duration>

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingest_delay: Option<Duration>

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

time_series_resource_hierarchy_level: Vec<TimeSeriesResourceHierarchyLevel>

The scope of the timeseries data of the metric.

Implementations

impl MetricDescriptorMetadata

pub fn set_launch_stage<T: Into<LaunchStage>>(self, v: T) -> Self

Sets the value of launch_stage.

pub fn set_sample_period<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of sample_period.

pub fn set_ingest_delay<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of ingest_delay.

pub fn set_time_series_resource_hierarchy_level<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<TimeSeriesResourceHierarchyLevel>,

Sets the value of time_series_resource_hierarchy_level.

Trait Implementations

impl Clone for MetricDescriptorMetadata

fn clone(&self) -> MetricDescriptorMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDescriptorMetadata

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

Formats the value using the given formatter.

impl Default for MetricDescriptorMetadata

fn default() -> MetricDescriptorMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricDescriptorMetadata

where MetricDescriptorMetadata: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for MetricDescriptorMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MetricDescriptorMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MetricDescriptorMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricDescriptorMetadata