Reference documentation and code samples for the Stackdriver Monitoring V3 Client class NotificationChannelDescriptor.
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.
Generated from protobuf message google.monitoring.v3.NotificationChannelDescriptor
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
array< Google\Api\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
array
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
↳ launch_stage
int
The product launch stage for channels of this type.
getName
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.
Generated from protobuf field string name = 6;
string
setName
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.
Generated from protobuf field string name = 6;
var
string
$this
getType
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.
Generated from protobuf field string type = 1;
string
setType
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.
Generated from protobuf field string type = 1;
var
string
$this
getDisplayName
A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
Generated from protobuf field string display_name = 2;
string
setDisplayName
A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
Generated from protobuf field string display_name = 2;
var
string
$this
getDescription
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.
Generated from protobuf field string description = 3;
string
setDescription
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.
Generated from protobuf field string description = 3;
var
string
$this
getLabels
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.
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;
Google\Protobuf\Internal\RepeatedField
setLabels
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.
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;
$this
getSupportedTiers
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
Generated from protobuf field repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];
Google\Protobuf\Internal\RepeatedField
setSupportedTiers
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
Generated from protobuf field repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];
var
int[]
$this
getLaunchStage
The product launch stage for channels of this type.
Generated from protobuf field .google.api.LaunchStage launch_stage = 7;
int
setLaunchStage
The product launch stage for channels of this type.
Generated from protobuf field .google.api.LaunchStage launch_stage = 7;
var
int
$this
