List
|
|||||
|
|
||||
Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added
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 3 input parameters
| Name | Format | Description |
|---|---|---|
name Required |
STRING |
The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead |
pageToken |
STRING |
If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results |
pageSize |
INTEGER |
The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service |
= Parameter name
= Format
|
name STRING Required The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead |
|
pageToken STRING If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results |
|
pageSize INTEGER The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service |
Output
This building block provides 11 output parameters
| Name | Format | Description |
|---|---|---|
channelDescriptors[] |
OBJECT |
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 |
channelDescriptors[].labels[] |
OBJECT |
A description of a label |
channelDescriptors[].labels[].valueType |
ENUMERATION |
The type of data that can be assigned to the label |
channelDescriptors[].labels[].key |
STRING |
The label key |
channelDescriptors[].labels[].description |
STRING |
A human-readable description for the label |
channelDescriptors[].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 |
channelDescriptors[].type |
STRING |
The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique |
channelDescriptors[].displayName |
STRING |
A human-readable name for the notification channel type. This form of the name is suitable for a user interface |
channelDescriptors[].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 |
channelDescriptors[].supportedTiers[] |
ENUMERATION |
|
nextPageToken |
STRING |
If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned |
= Parameter name
= Format
|
channelDescriptors[] OBJECT 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 |
|
channelDescriptors[].labels[] OBJECT A description of a label |
|
channelDescriptors[].labels[].valueType ENUMERATION The type of data that can be assigned to the label |
|
channelDescriptors[].labels[].key STRING The label key |
|
channelDescriptors[].labels[].description STRING A human-readable description for the label |
|
channelDescriptors[].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 |
|
channelDescriptors[].type STRING The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique |
|
channelDescriptors[].displayName STRING A human-readable name for the notification channel type. This form of the name is suitable for a user interface |
|
channelDescriptors[].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 |
|
channelDescriptors[].supportedTiers[] ENUMERATION |
|
nextPageToken STRING If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned |