docs/dyn/monitoring_v3.projects.notificationChannelDescriptors.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.notificationChannelDescriptors.html">notificationChannelDescriptors</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <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>
 <p class="toc_element">
   <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
 <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>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

 Args:
   name: string, The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # 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.
     "displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
     "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.
     "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.
       { # A description of a label.
         "valueType": "A String", # The type of data that can be assigned to the label.
         "description": "A String", # A human-readable description for the label.
         "key": "A String", # The label key.
       },
     ],
     "supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
       "A String",
     ],
     "type": "A String", # The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.
     "name": "A 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.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
   <pre>Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

 Args:
   name: 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. (required)
   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.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
   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.

 Returns:
   An object of the form:

     { # The ListNotificationChannelDescriptors response.
     "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.
     "channelDescriptors": [ # The monitored resource descriptors supported for the specified project, optionally filtered.
       { # 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.
         "displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
         "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.
         "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.
           { # A description of a label.
             "valueType": "A String", # The type of data that can be assigned to the label.
             "description": "A String", # A human-readable description for the label.
             "key": "A String", # The label key.
           },
         ],
         "supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
           "A String",
         ],
         "type": "A String", # The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.
         "name": "A 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.
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.notificationChannelDescriptors.html">notificationChannelDescriptors</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<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>
	<p class="toc_element">
	<code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
	<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>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="get">get(name, x__xgafv=None)</code>
	<pre>Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

	Args:
	name: string, The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # 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.
	"displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
	"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.
	"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.
	{ # A description of a label.
	"valueType": "A String", # The type of data that can be assigned to the label.
	"description": "A String", # A human-readable description for the label.
	"key": "A String", # The label key.
	},
	],
	"supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
	"A String",
	],
	"type": "A String", # The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.
	"name": "A 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.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
	<pre>Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

	Args:
	name: 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. (required)
	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.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format
	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.

	Returns:
	An object of the form:

	{ # The ListNotificationChannelDescriptors response.
	"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.
	"channelDescriptors": [ # The monitored resource descriptors supported for the specified project, optionally filtered.
	{ # 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.
	"displayName": "A String", # A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
	"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.
	"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.
	{ # A description of a label.
	"valueType": "A String", # The type of data that can be assigned to the label.
	"description": "A String", # A human-readable description for the label.
	"key": "A String", # The label key.
	},
	],
	"supportedTiers": [ # The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
	"A String",
	],
	"type": "A String", # The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.
	"name": "A 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.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	</body></html>