Get
|
|||||
|
|
||||
Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and write monitoring data for all of your Google and third-party Cloud and API projects
- View monitoring data for all of your Google Cloud and third-party projects
Input
This building block consumes 1 input parameters
| Name | Format | Description |
|---|---|---|
name Required |
STRING |
The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type} |
= Parameter name
= Format
|
name STRING Required The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type} |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
labels[] |
OBJECT |
A description of a label |
labels[].valueType |
ENUMERATION |
The type of data that can be assigned to the label |
labels[].key |
STRING |
The label key |
labels[].description |
STRING |
A human-readable description for the label |
name |
STRING |
The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field |
type |
STRING |
The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique |
displayName |
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 |
supportedTiers[] |
ENUMERATION |
= Parameter name
= Format
|
labels[] OBJECT A description of a label |
|
labels[].valueType ENUMERATION The type of data that can be assigned to the label |
|
labels[].key STRING The label key |
|
labels[].description STRING A human-readable description for the label |
|
name STRING The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field |
|
type STRING The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique |
|
displayName 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 |
|
supportedTiers[] ENUMERATION |