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">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a single monitored resource descriptor. This method does not require a Stackdriver account.</p>
80<p class="toc_element">
81  <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(name, x__xgafv=None)</code>
89  <pre>Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
90
91Args:
92  name: string, The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. (required)
93  x__xgafv: string, V1 error format.
94    Allowed values
95      1 - v1 error format
96      2 - v2 error format
97
98Returns:
99  An object of the form:
100
101    { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
102    "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
103    "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
104      { # A description of a label.
105        "valueType": "A String", # The type of data that can be assigned to the label.
106        "description": "A String", # A human-readable description for the label.
107        "key": "A String", # The label key.
108      },
109    ],
110    "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
111    "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
112    "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
113  }</pre>
114</div>
115
116<div class="method">
117    <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
118  <pre>Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
119
120Args:
121  name: string, The project on which to execute the request. The format is "projects/{project_id_or_number}". (required)
122  pageSize: integer, A positive number that is the maximum number of results to return.
123  filter: string, An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:
124resource.type = starts_with("gce_") AND resource.label:id
125
126  pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
127  x__xgafv: string, V1 error format.
128    Allowed values
129      1 - v1 error format
130      2 - v2 error format
131
132Returns:
133  An object of the form:
134
135    { # The ListMonitoredResourceDescriptors response.
136    "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
137    "resourceDescriptors": [ # The monitored resource descriptors that are available to this project and that match filter, if present.
138      { # An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
139        "type": "A String", # Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
140        "labels": [ # Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
141          { # A description of a label.
142            "valueType": "A String", # The type of data that can be assigned to the label.
143            "description": "A String", # A human-readable description for the label.
144            "key": "A String", # The label key.
145          },
146        ],
147        "displayName": "A String", # Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
148        "name": "A String", # Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
149        "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
150      },
151    ],
152  }</pre>
153</div>
154
155<div class="method">
156    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
157  <pre>Retrieves the next page of results.
158
159Args:
160  previous_request: The request for the previous page. (required)
161  previous_response: The response from the request for the previous page. (required)
162
163Returns:
164  A request object that you can call 'execute()' on to request the next
165  page. Returns None if there are no more items in the collection.
166    </pre>
167</div>
168
169</body></html>