Struct ServiceLevelObjective

#[non_exhaustive]
pub struct ServiceLevelObjective {
    pub name: String,
    pub display_name: String,
    pub service_level_indicator: Option<ServiceLevelIndicator>,
    pub goal: f64,
    pub user_labels: HashMap<String, String>,
    pub period: Option<Period>,
}

A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include “99% of requests in each rolling week have latency below 200 milliseconds” or “99.5% of requests in each calendar month return successfully.”

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.

name: String

Identifier. Resource name for this ServiceLevelObjective. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

display_name: String

Name used for UI elements listing this SLO.

service_level_indicator: Option<ServiceLevelIndicator>

The definition of good service, used to measure and calculate the quality of the Service’s performance with respect to a single aspect of service quality.

goal: f64

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.

user_labels: HashMap<String, String>

Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

period: Option<Period>

The time period over which the objective will be evaluated.

Implementations

impl ServiceLevelObjective

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_service_level_indicator<T: Into<Option<ServiceLevelIndicator>>>( self, v: T, ) -> Self

Sets the value of service_level_indicator.

pub fn set_goal<T: Into<f64>>(self, v: T) -> Self

Sets the value of goal.

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of user_labels.

pub fn set_period<T: Into<Option<Period>>>(self, v: T) -> Self

Sets the value of period.

pub fn get_rolling_period(&self) -> Option<&Box<Duration>>

The value of period if it holds a RollingPeriod, None if the field is not set or holds a different branch.

pub fn get_calendar_period(&self) -> Option<&CalendarPeriod>

The value of period if it holds a CalendarPeriod, None if the field is not set or holds a different branch.

pub fn set_rolling_period<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of period to hold a RollingPeriod.

Note that all the setters affecting period are mutually exclusive.

pub fn set_calendar_period<T: Into<CalendarPeriod>>(self, v: T) -> Self

Sets the value of period to hold a CalendarPeriod.

Note that all the setters affecting period are mutually exclusive.

Trait Implementations

impl Clone for ServiceLevelObjective

fn clone(&self) -> ServiceLevelObjective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceLevelObjective

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

Formats the value using the given formatter.

impl Default for ServiceLevelObjective

fn default() -> ServiceLevelObjective

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServiceLevelObjective

where ServiceLevelObjective: 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 ServiceLevelObjective

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ServiceLevelObjective

fn eq(&self, other: &ServiceLevelObjective) -> 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 ServiceLevelObjective

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 ServiceLevelObjective