• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists the descriptors for monitored resource types used by Stackdriver Logging.</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
86  <pre>Lists the descriptors for monitored resource types used by Stackdriver Logging.
87
88Args:
89  pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
90  pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
91  x__xgafv: string, V1 error format.
92    Allowed values
93      1 - v1 error format
94      2 - v2 error format
95
96Returns:
97  An object of the form:
98
99    { # Result returned from ListMonitoredResourceDescriptors.
100    "nextPageToken": "A String", # If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
101    "resourceDescriptors": [ # A list of resource descriptors.
102      { # 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.
103        "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.
104        "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".
105          { # A description of a label.
106            "valueType": "A String", # The type of data that can be assigned to the label.
107            "description": "A String", # A human-readable description for the label.
108            "key": "A String", # The label key.
109          },
110        ],
111        "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".
112        "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
113        "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}".
114      },
115    ],
116  }</pre>
117</div>
118
119<div class="method">
120    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
121  <pre>Retrieves the next page of results.
122
123Args:
124  previous_request: The request for the previous page. (required)
125  previous_response: The response from the request for the previous page. (required)
126
127Returns:
128  A request object that you can call 'execute()' on to request the next
129  page. Returns None if there are no more items in the collection.
130    </pre>
131</div>
132
133</body></html>