Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / logging_v2beta1.projects.metrics.html
blob: 5884077642a530ae8d9b3ef61526f8bc65955952 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]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_v2beta1.html">Google Cloud Logging API</a> . <a href="logging_v2beta1.projects.html">projects</a> . <a href="logging_v2beta1.projects.metrics.html">metrics</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectName, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a logs-based metric.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(metricName, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a logs-based metric.</p>
83<p class="toc_element">
84 <code><a href="#get">get(metricName, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a logs-based metric.</p>
86<p class="toc_element">
87 <code><a href="#list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists logs-based metrics.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#update">update(metricName, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Creates or updates a logs-based metric.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(projectName, body, x__xgafv=None)</code>
98 <pre>Creates a logs-based metric.
99
100Args:
101 projectName: string, The resource name of the project in which to create the metric. Example: `"projects/my-project-id"`. The new metric must be provided in the request. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
106 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
107 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
108 "description": "A String", # A description of this metric, which is used in documentation.
109 }
110
111 x__xgafv: string, V1 error format.
112
113Returns:
114 An object of the form:
115
116 { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
117 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
118 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
119 "description": "A String", # A description of this metric, which is used in documentation.
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="delete">delete(metricName, x__xgafv=None)</code>
125 <pre>Deletes a logs-based metric.
126
127Args:
128 metricName: string, The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
129 x__xgafv: string, V1 error format.
130
131Returns:
132 An object of the form:
133
134 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="get">get(metricName, x__xgafv=None)</code>
140 <pre>Gets a logs-based metric.
141
142Args:
143 metricName: string, The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
144 x__xgafv: string, V1 error format.
145
146Returns:
147 An object of the form:
148
149 { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
150 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
151 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
152 "description": "A String", # A description of this metric, which is used in documentation.
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="list">list(projectName, pageSize=None, pageToken=None, x__xgafv=None)</code>
158 <pre>Lists logs-based metrics.
159
160Args:
161 projectName: string, Required. The resource name of the project containing the metrics. Example: `"projects/my-project-id"`. (required)
162 pageSize: integer, Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
163 pageToken: string, Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.
164 x__xgafv: string, V1 error format.
165
166Returns:
167 An object of the form:
168
169 { # Result returned from ListLogMetrics.
170 "metrics": [ # A list of logs-based metrics.
171 { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
172 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
173 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
174 "description": "A String", # A description of this metric, which is used in documentation.
175 },
176 ],
177 "nextPageToken": "A String", # If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
183 <pre>Retrieves the next page of results.
184
185Args:
186 previous_request: The request for the previous page. (required)
187 previous_response: The response from the request for the previous page. (required)
188
189Returns:
190 A request object that you can call 'execute()' on to request the next
191 page. Returns None if there are no more items in the collection.
192 </pre>
193</div>
194
195<div class="method">
196 <code class="details" id="update">update(metricName, body, x__xgafv=None)</code>
197 <pre>Creates or updates a logs-based metric.
198
199Args:
200 metricName: string, The resource name of the metric to update. Example: `"projects/my-project-id/metrics/my-metric-id"`. The updated metric must be provided in the request and have the same identifier that is specified in `metricName`. If the metric does not exist, it is created. (required)
201 body: object, The request body. (required)
202 The object takes the form of:
203
204{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
205 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
206 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
207 "description": "A String", # A description of this metric, which is used in documentation.
208 }
209
210 x__xgafv: string, V1 error format.
211
212Returns:
213 An object of the form:
214
215 { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
216 "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
217 "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
218 "description": "A String", # A description of this metric, which is used in documentation.
219 }</pre>
220</div>
221
222</body></html>