File: logging_v2beta1.monitoredResourceDescriptors.html

package info (click to toggle)
python-googleapi 1.5.5-1
  • links: PTS
  • area: main
  • in suites: buster, stretch
  • size: 39,832 kB
  • ctags: 5,921
  • sloc: python: 7,176; makefile: 64; sh: 53; xml: 5
file content (161 lines) | stat: -rw-r--r-- 5,639 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<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="logging_v2beta1.html">Stackdriver Logging API</a> . <a href="logging_v2beta1.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the monitored resource descriptors used by Stackdriver Logging.</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="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the monitored resource descriptors used by Stackdriver Logging.

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

Returns:
  An object of the form:

    { # Result returned from ListMonitoredResourceDescriptors.
    "nextPageToken": "A String", # If there might be more results than appear 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`.
    "resourceDescriptors": [ # A list of resource descriptors.
      { # 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.
        "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.
        "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"`.
          { # 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.
          },
        ],
        "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"`.
        "description": "A String", # Optional. A detailed description of the monitored resource type that might
            # be used in documentation.
        "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}"`.
      },
    ],
  }</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>