Struct NotificationChannelDescriptor

#[non_exhaustive]
pub struct NotificationChannelDescriptor {
    pub name: String,
    pub type: String,
    pub display_name: String,
    pub description: String,
    pub labels: Vec<LabelDescriptor>,
    pub supported_tiers: Vec<ServiceTier>,
    pub launch_stage: LaunchStage,
}

A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

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

The full REST resource name for this descriptor. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]

In the above, [TYPE] is the value of the type field.

type: String

The type of notification channel, such as “email” and “sms”. To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

display_name: String

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

description: String

A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.

labels: Vec<LabelDescriptor>

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.

supported_tiers: Vec<ServiceTier>

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

launch_stage: LaunchStage

The product launch stage for channels of this type.

Implementations

impl NotificationChannelDescriptor

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

Sets the value of name.

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

Sets the value of r#type.

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

Sets the value of display_name.

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

Sets the value of description.

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

Sets the value of launch_stage.

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

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

Sets the value of labels.

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

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

Sets the value of supported_tiers.

Trait Implementations

impl Clone for NotificationChannelDescriptor

fn clone(&self) -> NotificationChannelDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationChannelDescriptor

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

Formats the value using the given formatter.

impl Default for NotificationChannelDescriptor

fn default() -> NotificationChannelDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NotificationChannelDescriptor

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

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NotificationChannelDescriptor

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

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 NotificationChannelDescriptor