1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="monitoring_v3.html">Cloud Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.notificationChannelDescriptors.html">notificationChannelDescriptors</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(name, x__xgafv=None)</code> 97 <pre>Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type. 98 99Args: 100 name: string, Required. The channel type for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE] (required) 101 x__xgafv: string, V1 error format. 102 Allowed values 103 1 - v1 error format 104 2 - v2 error format 105 106Returns: 107 An object of the form: 108 109 { # 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. 110 "description": "A 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. 111 "displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface. 112 "labels": [ # 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. 113 { # A description of a label. 114 "description": "A String", # A human-readable description for the label. 115 "key": "A String", # The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores. 116 "valueType": "A String", # The type of data that can be assigned to the label. 117 }, 118 ], 119 "launchStage": "A String", # The product launch stage for channels of this type. 120 "name": "A 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. 121 "supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers. 122 "A String", 123 ], 124 "type": "A String", # The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique. 125}</pre> 126</div> 127 128<div class="method"> 129 <code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code> 130 <pre>Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added. 131 132Args: 133 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_OR_NUMBER] Note that this names (https://cloud.google.com/monitoring/api/v3#project_name) the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. (required) 134 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. 135 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. 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # The ListNotificationChannelDescriptors response. 145 "channelDescriptors": [ # The monitored resource descriptors supported for the specified project, optionally filtered. 146 { # 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. 147 "description": "A 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. 148 "displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface. 149 "labels": [ # 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. 150 { # A description of a label. 151 "description": "A String", # A human-readable description for the label. 152 "key": "A String", # The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores. 153 "valueType": "A String", # The type of data that can be assigned to the label. 154 }, 155 ], 156 "launchStage": "A String", # The product launch stage for channels of this type. 157 "name": "A 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. 158 "supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers. 159 "A String", 160 ], 161 "type": "A String", # The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique. 162 }, 163 ], 164 "nextPageToken": "A 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. 165}</pre> 166</div> 167 168<div class="method"> 169 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 170 <pre>Retrieves the next page of results. 171 172Args: 173 previous_request: The request for the previous page. (required) 174 previous_response: The response from the request for the previous page. (required) 175 176Returns: 177 A request object that you can call 'execute()' on to request the next 178 page. Returns None if there are no more items in the collection. 179 </pre> 180</div> 181 182</body></html>