OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
9 "description": "View your data across Google Cloud Platform
services" | 9 "description": "View your data across Google Cloud Platform
services" |
10 }, | 10 }, |
11 "https://www.googleapis.com/auth/logging.admin": { | |
12 "description": "Administrate log data for your projects" | |
13 }, | |
14 "https://www.googleapis.com/auth/logging.read": { | 11 "https://www.googleapis.com/auth/logging.read": { |
15 "description": "View log data for your projects" | 12 "description": "View log data for your projects" |
16 }, | 13 }, |
17 "https://www.googleapis.com/auth/logging.write": { | 14 "https://www.googleapis.com/auth/logging.write": { |
18 "description": "Submit log data for your projects" | 15 "description": "Submit log data for your projects" |
| 16 }, |
| 17 "https://www.googleapis.com/auth/logging.admin": { |
| 18 "description": "Administrate log data for your projects" |
19 } | 19 } |
20 } | 20 } |
21 } | 21 } |
22 }, | 22 }, |
23 "basePath": "", | 23 "basePath": "", |
24 "baseUrl": "https://logging.googleapis.com/", | 24 "baseUrl": "https://logging.googleapis.com/", |
25 "batchPath": "batch", | 25 "batchPath": "batch", |
26 "description": "Writes log entries and manages your logs, log sinks, and log
s-based metrics.", | 26 "canonicalName": "Logging", |
| 27 "description": "Writes log entries and manages your Stackdriver Logging conf
iguration.", |
27 "discoveryVersion": "v1", | 28 "discoveryVersion": "v1", |
28 "documentationLink": "https://cloud.google.com/logging/docs/", | 29 "documentationLink": "https://cloud.google.com/logging/docs/", |
29 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/AGY2FGWaHRZwgyAazem2sSX20dM\"", | |
30 "icons": { | 30 "icons": { |
31 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 31 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
32 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 32 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
33 }, | 33 }, |
34 "id": "logging:v2beta1", | 34 "id": "logging:v2beta1", |
35 "kind": "discovery#restDescription", | 35 "kind": "discovery#restDescription", |
36 "name": "logging", | 36 "name": "logging", |
37 "ownerDomain": "google.com", | 37 "ownerDomain": "google.com", |
38 "ownerName": "Google", | 38 "ownerName": "Google", |
39 "parameters": { | 39 "parameters": { |
40 "access_token": { | 40 "access_token": { |
41 "description": "OAuth access token.", | 41 "description": "OAuth access token.", |
42 "location": "query", | 42 "location": "query", |
43 "type": "string" | 43 "type": "string" |
44 }, | 44 }, |
| 45 "prettyPrint": { |
| 46 "default": "true", |
| 47 "description": "Returns response with indentations and line breaks."
, |
| 48 "location": "query", |
| 49 "type": "boolean" |
| 50 }, |
| 51 "key": { |
| 52 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "quotaUser": { |
| 57 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "pp": { |
| 62 "default": "true", |
| 63 "description": "Pretty-print response.", |
| 64 "location": "query", |
| 65 "type": "boolean" |
| 66 }, |
| 67 "fields": { |
| 68 "description": "Selector specifying which fields to include in a par
tial response.", |
| 69 "location": "query", |
| 70 "type": "string" |
| 71 }, |
45 "alt": { | 72 "alt": { |
46 "default": "json", | 73 "default": "json", |
47 "description": "Data format for response.", | 74 "description": "Data format for response.", |
| 75 "enum": [ |
| 76 "json", |
| 77 "media", |
| 78 "proto" |
| 79 ], |
48 "enumDescriptions": [ | 80 "enumDescriptions": [ |
49 "Responses with Content-Type of application/json", | 81 "Responses with Content-Type of application/json", |
50 "Media download with context-dependent Content-Type", | 82 "Media download with context-dependent Content-Type", |
51 "Responses with Content-Type of application/x-protobuf" | 83 "Responses with Content-Type of application/x-protobuf" |
52 ], | 84 ], |
53 "location": "query", | 85 "location": "query", |
54 "type": "string" | 86 "type": "string" |
55 }, | 87 }, |
56 "bearer_token": { | 88 "$.xgafv": { |
57 "description": "OAuth bearer token.", | 89 "description": "V1 error format.", |
| 90 "enum": [ |
| 91 "1", |
| 92 "2" |
| 93 ], |
| 94 "enumDescriptions": [ |
| 95 "v1 error format", |
| 96 "v2 error format" |
| 97 ], |
58 "location": "query", | 98 "location": "query", |
59 "type": "string" | 99 "type": "string" |
60 }, | 100 }, |
61 "callback": { | 101 "callback": { |
62 "description": "JSONP", | 102 "description": "JSONP", |
63 "location": "query", | 103 "location": "query", |
64 "type": "string" | 104 "type": "string" |
65 }, | 105 }, |
66 "fields": { | |
67 "description": "Selector specifying which fields to include in a par
tial response.", | |
68 "location": "query", | |
69 "type": "string" | |
70 }, | |
71 "key": { | |
72 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
73 "location": "query", | |
74 "type": "string" | |
75 }, | |
76 "oauth_token": { | 106 "oauth_token": { |
77 "description": "OAuth 2.0 token for the current user.", | 107 "description": "OAuth 2.0 token for the current user.", |
78 "location": "query", | 108 "location": "query", |
79 "type": "string" | 109 "type": "string" |
80 }, | 110 }, |
81 "pp": { | 111 "uploadType": { |
82 "default": "true", | 112 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
83 "description": "Pretty-print response.", | |
84 "location": "query", | |
85 "type": "boolean" | |
86 }, | |
87 "prettyPrint": { | |
88 "default": "true", | |
89 "description": "Returns response with indentations and line breaks."
, | |
90 "location": "query", | |
91 "type": "boolean" | |
92 }, | |
93 "quotaUser": { | |
94 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
95 "location": "query", | 113 "location": "query", |
96 "type": "string" | 114 "type": "string" |
97 }, | 115 }, |
| 116 "bearer_token": { |
| 117 "description": "OAuth bearer token.", |
| 118 "location": "query", |
| 119 "type": "string" |
| 120 }, |
98 "upload_protocol": { | 121 "upload_protocol": { |
99 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 122 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
100 "location": "query", | 123 "location": "query", |
101 "type": "string" | 124 "type": "string" |
102 }, | |
103 "uploadType": { | |
104 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
105 "location": "query", | |
106 "type": "string" | |
107 }, | |
108 "$.xgafv": { | |
109 "description": "V1 error format.", | |
110 "enumDescriptions": [ | |
111 "v1 error format", | |
112 "v2 error format" | |
113 ], | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 125 } |
117 }, | 126 }, |
118 "protocol": "rest", | 127 "protocol": "rest", |
119 "resources": { | 128 "resources": { |
120 "projects": { | 129 "projects": { |
121 "resources": { | 130 "resources": { |
122 "logs": { | 131 "metrics": { |
123 "methods": { | 132 "methods": { |
124 "delete": { | 133 "update": { |
125 "description": "Deletes a log and all its log entrie
s. The log will reappear if it receives new entries.", | 134 "description": "Creates or updates a logs-based metr
ic.", |
126 "httpMethod": "DELETE", | 135 "httpMethod": "PUT", |
127 "id": "logging.projects.logs.delete", | 136 "id": "logging.projects.metrics.update", |
128 "parameterOrder": [ | 137 "parameterOrder": [ |
129 "logName" | 138 "metricName" |
130 ], | 139 ], |
131 "parameters": { | 140 "parameters": { |
132 "logName": { | 141 "metricName": { |
133 "description": "Required. The resource name
of the log to delete. Example: `\"projects/my-project/logs/syslog\"`.", | 142 "description": "The resource name of the met
ric to update.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.\n\nT
he updated metric must be provided in the request and have the\nsame identifier
that is specified in `metricName`.\nIf the metric does not exist, it is created.
", |
134 "location": "path", | 143 "location": "path", |
135 "pattern": "^projects/[^/]*/logs/[^/]*$", | 144 "pattern": "^projects/[^/]+/metrics/[^/]+$", |
136 "required": true, | 145 "required": true, |
137 "type": "string" | 146 "type": "string" |
138 } | 147 } |
139 }, | 148 }, |
140 "path": "v2beta1/{+logName}", | 149 "path": "v2beta1/{+metricName}", |
| 150 "request": { |
| 151 "$ref": "LogMetric" |
| 152 }, |
141 "response": { | 153 "response": { |
142 "$ref": "Empty" | 154 "$ref": "LogMetric" |
143 }, | 155 }, |
144 "scopes": [ | 156 "scopes": [ |
145 "https://www.googleapis.com/auth/cloud-platform"
, | 157 "https://www.googleapis.com/auth/cloud-platform"
, |
146 "https://www.googleapis.com/auth/logging.admin" | 158 "https://www.googleapis.com/auth/logging.admin", |
| 159 "https://www.googleapis.com/auth/logging.write" |
147 ] | 160 ] |
148 } | 161 }, |
149 } | 162 "get": { |
150 }, | 163 "description": "Gets a logs-based metric.", |
151 "sinks": { | |
152 "methods": { | |
153 "list": { | |
154 "description": "Lists sinks.", | |
155 "httpMethod": "GET", | 164 "httpMethod": "GET", |
156 "id": "logging.projects.sinks.list", | 165 "id": "logging.projects.metrics.get", |
157 "parameterOrder": [ | 166 "parameterOrder": [ |
158 "projectName" | 167 "metricName" |
159 ], | 168 ], |
160 "parameters": { | 169 "parameters": { |
161 "projectName": { | 170 "metricName": { |
162 "description": "Required. The resource name
of the project containing the sinks. Example: `\"projects/my-logging-project\"`.
", | 171 "description": "The resource name of the des
ired metric.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.", |
163 "location": "path", | 172 "location": "path", |
164 "pattern": "^projects/[^/]*$", | 173 "pattern": "^projects/[^/]+/metrics/[^/]+$", |
165 "required": true, | 174 "required": true, |
166 "type": "string" | 175 "type": "string" |
167 }, | |
168 "pageToken": { | |
169 "description": "Optional. If the `pageToken`
parameter is supplied, then the next page of results is retrieved. The `pageTok
en` parameter must be set to the value of the `nextPageToken` from the previous
response. The value of `projectName` must be the same as in the previous request
.", | |
170 "location": "query", | |
171 "type": "string" | |
172 }, | |
173 "pageSize": { | |
174 "description": "Optional. The maximum number
of results to return from this request. You must check for presence of `nextPag
eToken` to determine if additional results are available, which you can retrieve
by passing the `nextPageToken` value as the `pageToken` parameter in the next r
equest.", | |
175 "format": "int32", | |
176 "location": "query", | |
177 "type": "integer" | |
178 } | 176 } |
179 }, | 177 }, |
180 "path": "v2beta1/{+projectName}/sinks", | 178 "path": "v2beta1/{+metricName}", |
181 "response": { | 179 "response": { |
182 "$ref": "ListSinksResponse" | 180 "$ref": "LogMetric" |
183 }, | 181 }, |
184 "scopes": [ | 182 "scopes": [ |
185 "https://www.googleapis.com/auth/cloud-platform"
, | 183 "https://www.googleapis.com/auth/cloud-platform"
, |
186 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 184 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
187 "https://www.googleapis.com/auth/logging.admin", | 185 "https://www.googleapis.com/auth/logging.admin", |
188 "https://www.googleapis.com/auth/logging.read" | 186 "https://www.googleapis.com/auth/logging.read" |
189 ] | 187 ] |
190 }, | 188 }, |
191 "get": { | 189 "create": { |
192 "description": "Gets a sink.", | 190 "description": "Creates a logs-based metric.", |
193 "httpMethod": "GET", | 191 "httpMethod": "POST", |
194 "id": "logging.projects.sinks.get", | 192 "id": "logging.projects.metrics.create", |
195 "parameterOrder": [ | 193 "parameterOrder": [ |
196 "sinkName" | 194 "parent" |
197 ], | 195 ], |
198 "parameters": { | 196 "parameters": { |
199 "sinkName": { | 197 "parent": { |
200 "description": "The resource name of the sin
k to return. Example: `\"projects/my-project-id/sinks/my-sink-id\"`.", | 198 "description": "The resource name of the pro
ject in which to create the metric.\nExample: `\"projects/my-project-id\"`.\n\nT
he new metric must be provided in the request.", |
201 "location": "path", | 199 "location": "path", |
202 "pattern": "^projects/[^/]*/sinks/[^/]*$", | 200 "pattern": "^projects/[^/]+$", |
203 "required": true, | 201 "required": true, |
204 "type": "string" | 202 "type": "string" |
205 } | 203 } |
206 }, | 204 }, |
207 "path": "v2beta1/{+sinkName}", | 205 "path": "v2beta1/{+parent}/metrics", |
| 206 "request": { |
| 207 "$ref": "LogMetric" |
| 208 }, |
208 "response": { | 209 "response": { |
209 "$ref": "LogSink" | 210 "$ref": "LogMetric" |
| 211 }, |
| 212 "scopes": [ |
| 213 "https://www.googleapis.com/auth/cloud-platform"
, |
| 214 "https://www.googleapis.com/auth/logging.admin", |
| 215 "https://www.googleapis.com/auth/logging.write" |
| 216 ] |
| 217 }, |
| 218 "list": { |
| 219 "description": "Lists logs-based metrics.", |
| 220 "httpMethod": "GET", |
| 221 "id": "logging.projects.metrics.list", |
| 222 "parameterOrder": [ |
| 223 "parent" |
| 224 ], |
| 225 "parameters": { |
| 226 "pageSize": { |
| 227 "description": "Optional. The maximum number
of results to return from this request.\nNon-positive values are ignored. The
presence of `nextPageToken` in the\nresponse indicates that more results might b
e available.", |
| 228 "format": "int32", |
| 229 "location": "query", |
| 230 "type": "integer" |
| 231 }, |
| 232 "parent": { |
| 233 "description": "Required. The resource name
containing the metrics.\nExample: `\"projects/my-project-id\"`.", |
| 234 "location": "path", |
| 235 "pattern": "^projects/[^/]+$", |
| 236 "required": true, |
| 237 "type": "string" |
| 238 }, |
| 239 "pageToken": { |
| 240 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `pag
eToken` must be the value of\n`nextPageToken` from the previous response. The v
alues of other method\nparameters should be identical to those in the previous c
all.", |
| 241 "location": "query", |
| 242 "type": "string" |
| 243 } |
| 244 }, |
| 245 "path": "v2beta1/{+parent}/metrics", |
| 246 "response": { |
| 247 "$ref": "ListLogMetricsResponse" |
210 }, | 248 }, |
211 "scopes": [ | 249 "scopes": [ |
212 "https://www.googleapis.com/auth/cloud-platform"
, | 250 "https://www.googleapis.com/auth/cloud-platform"
, |
213 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 251 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
214 "https://www.googleapis.com/auth/logging.admin", | 252 "https://www.googleapis.com/auth/logging.admin", |
215 "https://www.googleapis.com/auth/logging.read" | 253 "https://www.googleapis.com/auth/logging.read" |
216 ] | 254 ] |
217 }, | 255 }, |
218 "create": { | 256 "delete": { |
219 "description": "Creates a sink.", | 257 "description": "Deletes a logs-based metric.", |
220 "httpMethod": "POST", | 258 "httpMethod": "DELETE", |
221 "id": "logging.projects.sinks.create", | 259 "id": "logging.projects.metrics.delete", |
222 "parameterOrder": [ | 260 "parameterOrder": [ |
223 "projectName" | 261 "metricName" |
224 ], | 262 ], |
225 "parameters": { | 263 "parameters": { |
226 "projectName": { | 264 "metricName": { |
227 "description": "The resource name of the pro
ject in which to create the sink. Example: `\"projects/my-project-id\"`. The new
sink must be provided in the request.", | 265 "description": "The resource name of the met
ric to delete.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.", |
228 "location": "path", | 266 "location": "path", |
229 "pattern": "^projects/[^/]*$", | 267 "pattern": "^projects/[^/]+/metrics/[^/]+$", |
230 "required": true, | 268 "required": true, |
231 "type": "string" | 269 "type": "string" |
232 } | 270 } |
233 }, | 271 }, |
234 "path": "v2beta1/{+projectName}/sinks", | 272 "path": "v2beta1/{+metricName}", |
235 "request": { | |
236 "$ref": "LogSink" | |
237 }, | |
238 "response": { | 273 "response": { |
239 "$ref": "LogSink" | 274 "$ref": "Empty" |
240 }, | 275 }, |
241 "scopes": [ | 276 "scopes": [ |
242 "https://www.googleapis.com/auth/cloud-platform"
, | 277 "https://www.googleapis.com/auth/cloud-platform"
, |
243 "https://www.googleapis.com/auth/logging.admin" | 278 "https://www.googleapis.com/auth/logging.admin", |
| 279 "https://www.googleapis.com/auth/logging.write" |
244 ] | 280 ] |
245 }, | 281 } |
246 "update": { | 282 } |
247 "description": "Creates or updates a sink.", | 283 }, |
248 "httpMethod": "PUT", | 284 "logs": { |
249 "id": "logging.projects.sinks.update", | 285 "methods": { |
| 286 "delete": { |
| 287 "description": "Deletes a log and all its log entrie
s.\nThe log will reappear if it receives new entries.", |
| 288 "httpMethod": "DELETE", |
| 289 "id": "logging.projects.logs.delete", |
250 "parameterOrder": [ | 290 "parameterOrder": [ |
251 "sinkName" | 291 "logName" |
252 ], | 292 ], |
253 "parameters": { | 293 "parameters": { |
254 "sinkName": { | 294 "logName": { |
255 "description": "The resource name of the sin
k to update. Example: `\"projects/my-project-id/sinks/my-sink-id\"`. The updated
sink must be provided in the request and have the same name that is specified i
n `sinkName`. If the sink does not exist, it is created.", | 295 "description": "Required. The resource name
of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.", |
256 "location": "path", | 296 "location": "path", |
257 "pattern": "^projects/[^/]*/sinks/[^/]*$", | 297 "pattern": "^projects/[^/]+/logs/[^/]+$", |
258 "required": true, | 298 "required": true, |
259 "type": "string" | 299 "type": "string" |
260 } | 300 } |
261 }, | 301 }, |
262 "path": "v2beta1/{+sinkName}", | 302 "path": "v2beta1/{+logName}", |
263 "request": { | |
264 "$ref": "LogSink" | |
265 }, | |
266 "response": { | |
267 "$ref": "LogSink" | |
268 }, | |
269 "scopes": [ | |
270 "https://www.googleapis.com/auth/cloud-platform"
, | |
271 "https://www.googleapis.com/auth/logging.admin" | |
272 ] | |
273 }, | |
274 "delete": { | |
275 "description": "Deletes a sink.", | |
276 "httpMethod": "DELETE", | |
277 "id": "logging.projects.sinks.delete", | |
278 "parameterOrder": [ | |
279 "sinkName" | |
280 ], | |
281 "parameters": { | |
282 "sinkName": { | |
283 "description": "The resource name of the sin
k to delete. Example: `\"projects/my-project-id/sinks/my-sink-id\"`.", | |
284 "location": "path", | |
285 "pattern": "^projects/[^/]*/sinks/[^/]*$", | |
286 "required": true, | |
287 "type": "string" | |
288 } | |
289 }, | |
290 "path": "v2beta1/{+sinkName}", | |
291 "response": { | 303 "response": { |
292 "$ref": "Empty" | 304 "$ref": "Empty" |
293 }, | 305 }, |
294 "scopes": [ | 306 "scopes": [ |
295 "https://www.googleapis.com/auth/cloud-platform"
, | 307 "https://www.googleapis.com/auth/cloud-platform"
, |
296 "https://www.googleapis.com/auth/logging.admin" | 308 "https://www.googleapis.com/auth/logging.admin" |
297 ] | 309 ] |
298 } | 310 } |
299 } | 311 } |
300 }, | 312 }, |
301 "metrics": { | 313 "sinks": { |
302 "methods": { | 314 "methods": { |
303 "list": { | 315 "update": { |
304 "description": "Lists logs-based metrics.", | 316 "description": "Updates or creates a sink.", |
305 "httpMethod": "GET", | 317 "httpMethod": "PUT", |
306 "id": "logging.projects.metrics.list", | 318 "id": "logging.projects.sinks.update", |
307 "parameterOrder": [ | 319 "parameterOrder": [ |
308 "projectName" | 320 "sinkName" |
309 ], | 321 ], |
310 "parameters": { | 322 "parameters": { |
311 "projectName": { | 323 "sinkName": { |
312 "description": "Required. The resource name
of the project containing the metrics. Example: `\"projects/my-project-id\"`.", | 324 "description": "Required. The resource name
of the sink to update, including the parent\nresource and the sink identifier.
If the sink does not exist, this method\ncreates the sink. Example: `\"projects
/my-project-id/sinks/my-sink-id\"`.", |
313 "location": "path", | 325 "location": "path", |
314 "pattern": "^projects/[^/]*$", | 326 "pattern": "^projects/[^/]+/sinks/[^/]+$", |
315 "required": true, | 327 "required": true, |
316 "type": "string" | 328 "type": "string" |
317 }, | 329 }, |
318 "pageToken": { | 330 "uniqueWriterIdentity": { |
319 "description": "Optional. If the `pageToken`
parameter is supplied, then the next page of results is retrieved. The `pageTok
en` parameter must be set to the value of the `nextPageToken` from the previous
response. The value of `projectName` must be the same as in the previous request
.", | 331 "description": "Optional. Whether the sink w
ill have a dedicated service account returned\nin the sink's writer_identity. Se
t this field to be true to export\nlogs from one project to a different project.
This field is ignored for\nnon-project sinks (e.g. organization sinks) because
those sinks are\nrequired to have dedicated service accounts.", |
320 "location": "query", | 332 "location": "query", |
321 "type": "string" | 333 "type": "boolean" |
322 }, | |
323 "pageSize": { | |
324 "description": "Optional. The maximum number
of results to return from this request. You must check for presence of `nextPag
eToken` to determine if additional results are available, which you can retrieve
by passing the `nextPageToken` value as the `pageToken` parameter in the next r
equest.", | |
325 "format": "int32", | |
326 "location": "query", | |
327 "type": "integer" | |
328 } | 334 } |
329 }, | 335 }, |
330 "path": "v2beta1/{+projectName}/metrics", | 336 "path": "v2beta1/{+sinkName}", |
| 337 "request": { |
| 338 "$ref": "LogSink" |
| 339 }, |
331 "response": { | 340 "response": { |
332 "$ref": "ListLogMetricsResponse" | 341 "$ref": "LogSink" |
333 }, | 342 }, |
334 "scopes": [ | 343 "scopes": [ |
335 "https://www.googleapis.com/auth/cloud-platform"
, | 344 "https://www.googleapis.com/auth/cloud-platform"
, |
336 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 345 "https://www.googleapis.com/auth/logging.admin" |
337 "https://www.googleapis.com/auth/logging.admin", | |
338 "https://www.googleapis.com/auth/logging.read" | |
339 ] | 346 ] |
340 }, | 347 }, |
341 "get": { | 348 "get": { |
342 "description": "Gets a logs-based metric.", | 349 "description": "Gets a sink.", |
343 "httpMethod": "GET", | 350 "httpMethod": "GET", |
344 "id": "logging.projects.metrics.get", | 351 "id": "logging.projects.sinks.get", |
345 "parameterOrder": [ | 352 "parameterOrder": [ |
346 "metricName" | 353 "sinkName" |
347 ], | 354 ], |
348 "parameters": { | 355 "parameters": { |
349 "metricName": { | 356 "sinkName": { |
350 "description": "The resource name of the des
ired metric. Example: `\"projects/my-project-id/metrics/my-metric-id\"`.", | 357 "description": "Required. The resource name
of the sink to return.\nExample: `\"projects/my-project-id/sinks/my-sink-id\"`."
, |
351 "location": "path", | 358 "location": "path", |
352 "pattern": "^projects/[^/]*/metrics/[^/]*$", | 359 "pattern": "^projects/[^/]+/sinks/[^/]+$", |
353 "required": true, | 360 "required": true, |
354 "type": "string" | 361 "type": "string" |
355 } | 362 } |
356 }, | 363 }, |
357 "path": "v2beta1/{+metricName}", | 364 "path": "v2beta1/{+sinkName}", |
358 "response": { | 365 "response": { |
359 "$ref": "LogMetric" | 366 "$ref": "LogSink" |
360 }, | 367 }, |
361 "scopes": [ | 368 "scopes": [ |
362 "https://www.googleapis.com/auth/cloud-platform"
, | 369 "https://www.googleapis.com/auth/cloud-platform"
, |
363 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 370 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
364 "https://www.googleapis.com/auth/logging.admin", | 371 "https://www.googleapis.com/auth/logging.admin", |
365 "https://www.googleapis.com/auth/logging.read" | 372 "https://www.googleapis.com/auth/logging.read" |
366 ] | 373 ] |
367 }, | 374 }, |
368 "create": { | 375 "create": { |
369 "description": "Creates a logs-based metric.", | 376 "description": "Creates a sink.", |
370 "httpMethod": "POST", | 377 "httpMethod": "POST", |
371 "id": "logging.projects.metrics.create", | 378 "id": "logging.projects.sinks.create", |
372 "parameterOrder": [ | 379 "parameterOrder": [ |
373 "projectName" | 380 "parent" |
374 ], | 381 ], |
375 "parameters": { | 382 "parameters": { |
376 "projectName": { | 383 "uniqueWriterIdentity": { |
377 "description": "The resource name of the pro
ject in which to create the metric. Example: `\"projects/my-project-id\"`. The n
ew metric must be provided in the request.", | 384 "description": "Optional. Whether the sink w
ill have a dedicated service account returned\nin the sink's writer_identity. Se
t this field to be true to export\nlogs from one project to a different project.
This field is ignored for\nnon-project sinks (e.g. organization sinks) because
those sinks are\nrequired to have dedicated service accounts.", |
| 385 "location": "query", |
| 386 "type": "boolean" |
| 387 }, |
| 388 "parent": { |
| 389 "description": "Required. The resource in wh
ich to create the sink.\nExample: `\"projects/my-project-id\"`.\nThe new sink mu
st be provided in the request.", |
378 "location": "path", | 390 "location": "path", |
379 "pattern": "^projects/[^/]*$", | 391 "pattern": "^projects/[^/]+$", |
380 "required": true, | 392 "required": true, |
381 "type": "string" | 393 "type": "string" |
382 } | 394 } |
383 }, | 395 }, |
384 "path": "v2beta1/{+projectName}/metrics", | 396 "path": "v2beta1/{+parent}/sinks", |
385 "request": { | 397 "request": { |
386 "$ref": "LogMetric" | 398 "$ref": "LogSink" |
387 }, | 399 }, |
388 "response": { | 400 "response": { |
389 "$ref": "LogMetric" | 401 "$ref": "LogSink" |
390 }, | 402 }, |
391 "scopes": [ | 403 "scopes": [ |
392 "https://www.googleapis.com/auth/cloud-platform"
, | 404 "https://www.googleapis.com/auth/cloud-platform"
, |
393 "https://www.googleapis.com/auth/logging.admin", | 405 "https://www.googleapis.com/auth/logging.admin" |
394 "https://www.googleapis.com/auth/logging.write" | |
395 ] | 406 ] |
396 }, | 407 }, |
397 "update": { | 408 "list": { |
398 "description": "Creates or updates a logs-based metr
ic.", | 409 "description": "Lists sinks.", |
399 "httpMethod": "PUT", | 410 "httpMethod": "GET", |
400 "id": "logging.projects.metrics.update", | 411 "id": "logging.projects.sinks.list", |
401 "parameterOrder": [ | 412 "parameterOrder": [ |
402 "metricName" | 413 "parent" |
403 ], | 414 ], |
404 "parameters": { | 415 "parameters": { |
405 "metricName": { | 416 "pageSize": { |
406 "description": "The resource name of the met
ric to update. Example: `\"projects/my-project-id/metrics/my-metric-id\"`. The u
pdated 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.", | 417 "description": "Optional. The maximum number
of results to return from this request.\nNon-positive values are ignored. The
presence of `nextPageToken` in the\nresponse indicates that more results might b
e available.", |
| 418 "format": "int32", |
| 419 "location": "query", |
| 420 "type": "integer" |
| 421 }, |
| 422 "parent": { |
| 423 "description": "Required. The resource name
where this sink was created.\nExample: `\"projects/my-logging-project\"`.", |
407 "location": "path", | 424 "location": "path", |
408 "pattern": "^projects/[^/]*/metrics/[^/]*$", | 425 "pattern": "^projects/[^/]+$", |
| 426 "required": true, |
| 427 "type": "string" |
| 428 }, |
| 429 "pageToken": { |
| 430 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `pag
eToken` must be the value of\n`nextPageToken` from the previous response. The v
alues of other method\nparameters should be identical to those in the previous c
all.", |
| 431 "location": "query", |
| 432 "type": "string" |
| 433 } |
| 434 }, |
| 435 "path": "v2beta1/{+parent}/sinks", |
| 436 "response": { |
| 437 "$ref": "ListSinksResponse" |
| 438 }, |
| 439 "scopes": [ |
| 440 "https://www.googleapis.com/auth/cloud-platform"
, |
| 441 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
| 442 "https://www.googleapis.com/auth/logging.admin", |
| 443 "https://www.googleapis.com/auth/logging.read" |
| 444 ] |
| 445 }, |
| 446 "delete": { |
| 447 "description": "Deletes a sink.", |
| 448 "httpMethod": "DELETE", |
| 449 "id": "logging.projects.sinks.delete", |
| 450 "parameterOrder": [ |
| 451 "sinkName" |
| 452 ], |
| 453 "parameters": { |
| 454 "sinkName": { |
| 455 "description": "Required. The resource name
of the sink to delete, including the parent\nresource and the sink identifier.
Example:\n`\"projects/my-project-id/sinks/my-sink-id\"`. It is an error if the
sink\ndoes not exist.", |
| 456 "location": "path", |
| 457 "pattern": "^projects/[^/]+/sinks/[^/]+$", |
409 "required": true, | 458 "required": true, |
410 "type": "string" | 459 "type": "string" |
411 } | 460 } |
412 }, | 461 }, |
413 "path": "v2beta1/{+metricName}", | 462 "path": "v2beta1/{+sinkName}", |
414 "request": { | |
415 "$ref": "LogMetric" | |
416 }, | |
417 "response": { | |
418 "$ref": "LogMetric" | |
419 }, | |
420 "scopes": [ | |
421 "https://www.googleapis.com/auth/cloud-platform"
, | |
422 "https://www.googleapis.com/auth/logging.admin", | |
423 "https://www.googleapis.com/auth/logging.write" | |
424 ] | |
425 }, | |
426 "delete": { | |
427 "description": "Deletes a logs-based metric.", | |
428 "httpMethod": "DELETE", | |
429 "id": "logging.projects.metrics.delete", | |
430 "parameterOrder": [ | |
431 "metricName" | |
432 ], | |
433 "parameters": { | |
434 "metricName": { | |
435 "description": "The resource name of the met
ric to delete. Example: `\"projects/my-project-id/metrics/my-metric-id\"`.", | |
436 "location": "path", | |
437 "pattern": "^projects/[^/]*/metrics/[^/]*$", | |
438 "required": true, | |
439 "type": "string" | |
440 } | |
441 }, | |
442 "path": "v2beta1/{+metricName}", | |
443 "response": { | 463 "response": { |
444 "$ref": "Empty" | 464 "$ref": "Empty" |
445 }, | 465 }, |
446 "scopes": [ | 466 "scopes": [ |
447 "https://www.googleapis.com/auth/cloud-platform"
, | 467 "https://www.googleapis.com/auth/cloud-platform"
, |
448 "https://www.googleapis.com/auth/logging.admin", | 468 "https://www.googleapis.com/auth/logging.admin" |
449 "https://www.googleapis.com/auth/logging.write" | |
450 ] | 469 ] |
451 } | 470 } |
452 } | 471 } |
| 472 } |
| 473 } |
| 474 }, |
| 475 "organizations": { |
| 476 "resources": { |
| 477 "logs": { |
| 478 "methods": { |
| 479 "delete": { |
| 480 "description": "Deletes a log and all its log entrie
s.\nThe log will reappear if it receives new entries.", |
| 481 "httpMethod": "DELETE", |
| 482 "id": "logging.organizations.logs.delete", |
| 483 "parameterOrder": [ |
| 484 "logName" |
| 485 ], |
| 486 "parameters": { |
| 487 "logName": { |
| 488 "description": "Required. The resource name
of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.", |
| 489 "location": "path", |
| 490 "pattern": "^organizations/[^/]+/logs/[^/]+$
", |
| 491 "required": true, |
| 492 "type": "string" |
| 493 } |
| 494 }, |
| 495 "path": "v2beta1/{+logName}", |
| 496 "response": { |
| 497 "$ref": "Empty" |
| 498 }, |
| 499 "scopes": [ |
| 500 "https://www.googleapis.com/auth/cloud-platform"
, |
| 501 "https://www.googleapis.com/auth/logging.admin" |
| 502 ] |
| 503 } |
| 504 } |
453 } | 505 } |
454 } | 506 } |
455 }, | 507 }, |
456 "entries": { | 508 "entries": { |
457 "methods": { | 509 "methods": { |
458 "write": { | 510 "write": { |
459 "description": "Writes log entries to Cloud Logging. All log
entries in Cloud Logging are written by this method.", | 511 "description": "Writes log entries to Stackdriver Logging.
All log entries are\nwritten by this method.", |
460 "httpMethod": "POST", | 512 "httpMethod": "POST", |
461 "id": "logging.entries.write", | 513 "id": "logging.entries.write", |
| 514 "parameterOrder": [], |
| 515 "parameters": {}, |
462 "path": "v2beta1/entries:write", | 516 "path": "v2beta1/entries:write", |
463 "request": { | 517 "request": { |
464 "$ref": "WriteLogEntriesRequest" | 518 "$ref": "WriteLogEntriesRequest" |
465 }, | 519 }, |
466 "response": { | 520 "response": { |
467 "$ref": "WriteLogEntriesResponse" | 521 "$ref": "WriteLogEntriesResponse" |
468 }, | 522 }, |
469 "scopes": [ | 523 "scopes": [ |
470 "https://www.googleapis.com/auth/cloud-platform", | 524 "https://www.googleapis.com/auth/cloud-platform", |
471 "https://www.googleapis.com/auth/logging.admin", | 525 "https://www.googleapis.com/auth/logging.admin", |
472 "https://www.googleapis.com/auth/logging.write" | 526 "https://www.googleapis.com/auth/logging.write" |
473 ] | 527 ] |
474 }, | 528 }, |
475 "list": { | 529 "list": { |
476 "description": "Lists log entries. Use this method to retrie
ve log entries from Cloud Logging. For ways to export log entries, see [Exportin
g Logs](/logging/docs/export).", | 530 "description": "Lists log entries. Use this method to retri
eve log entries from Cloud\nLogging. For ways to export log entries, see\n[Expo
rting Logs](/logging/docs/export).", |
477 "httpMethod": "POST", | 531 "httpMethod": "POST", |
478 "id": "logging.entries.list", | 532 "id": "logging.entries.list", |
| 533 "parameterOrder": [], |
| 534 "parameters": {}, |
479 "path": "v2beta1/entries:list", | 535 "path": "v2beta1/entries:list", |
480 "request": { | 536 "request": { |
481 "$ref": "ListLogEntriesRequest" | 537 "$ref": "ListLogEntriesRequest" |
482 }, | 538 }, |
483 "response": { | 539 "response": { |
484 "$ref": "ListLogEntriesResponse" | 540 "$ref": "ListLogEntriesResponse" |
485 }, | 541 }, |
486 "scopes": [ | 542 "scopes": [ |
487 "https://www.googleapis.com/auth/cloud-platform", | 543 "https://www.googleapis.com/auth/cloud-platform", |
488 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", | 544 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", |
489 "https://www.googleapis.com/auth/logging.admin", | 545 "https://www.googleapis.com/auth/logging.admin", |
490 "https://www.googleapis.com/auth/logging.read" | 546 "https://www.googleapis.com/auth/logging.read" |
491 ] | 547 ] |
492 } | 548 } |
493 } | 549 } |
494 }, | 550 }, |
495 "monitoredResourceDescriptors": { | 551 "monitoredResourceDescriptors": { |
496 "methods": { | 552 "methods": { |
497 "list": { | 553 "list": { |
498 "description": "Lists monitored resource descriptors that ar
e used by Cloud Logging.", | 554 "description": "Lists the monitored resource descriptors use
d by Stackdriver Logging.", |
499 "httpMethod": "GET", | 555 "httpMethod": "GET", |
500 "id": "logging.monitoredResourceDescriptors.list", | 556 "id": "logging.monitoredResourceDescriptors.list", |
| 557 "parameterOrder": [], |
501 "parameters": { | 558 "parameters": { |
502 "pageSize": { | 559 "pageSize": { |
503 "description": "Optional. The maximum number of resu
lts to return from this request. You must check for presence of `nextPageToken`
to determine if additional results are available, which you can retrieve by pass
ing the `nextPageToken` value as the `pageToken` parameter in the next request."
, | 560 "description": "Optional. The maximum number of resu
lts to return from this request.\nNon-positive values are ignored. The presence
of `nextPageToken` in the\nresponse indicates that more results might be availa
ble.", |
504 "format": "int32", | 561 "format": "int32", |
505 "location": "query", | 562 "location": "query", |
506 "type": "integer" | 563 "type": "integer" |
507 }, | 564 }, |
508 "pageToken": { | 565 "pageToken": { |
509 "description": "Optional. If the `pageToken` paramet
er is supplied, then the next page of results is retrieved. The `pageToken` para
meter must be set to the value of the `nextPageToken` from the previous response
.", | 566 "description": "Optional. If present, then retrieve
the next batch of results from the\npreceding call to this method. `pageToken`
must be the value of\n`nextPageToken` from the previous response. The values of
other method\nparameters should be identical to those in the previous call.", |
510 "location": "query", | 567 "location": "query", |
511 "type": "string" | 568 "type": "string" |
512 } | 569 } |
513 }, | 570 }, |
514 "path": "v2beta1/monitoredResourceDescriptors", | 571 "path": "v2beta1/monitoredResourceDescriptors", |
515 "response": { | 572 "response": { |
516 "$ref": "ListMonitoredResourceDescriptorsResponse" | 573 "$ref": "ListMonitoredResourceDescriptorsResponse" |
517 }, | 574 }, |
518 "scopes": [ | 575 "scopes": [ |
519 "https://www.googleapis.com/auth/cloud-platform", | 576 "https://www.googleapis.com/auth/cloud-platform", |
520 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", | 577 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", |
521 "https://www.googleapis.com/auth/logging.admin", | 578 "https://www.googleapis.com/auth/logging.admin", |
522 "https://www.googleapis.com/auth/logging.read" | 579 "https://www.googleapis.com/auth/logging.read" |
523 ] | 580 ] |
524 } | 581 } |
525 } | 582 } |
| 583 }, |
| 584 "billingAccounts": { |
| 585 "resources": { |
| 586 "logs": { |
| 587 "methods": { |
| 588 "delete": { |
| 589 "description": "Deletes a log and all its log entrie
s.\nThe log will reappear if it receives new entries.", |
| 590 "httpMethod": "DELETE", |
| 591 "id": "logging.billingAccounts.logs.delete", |
| 592 "parameterOrder": [ |
| 593 "logName" |
| 594 ], |
| 595 "parameters": { |
| 596 "logName": { |
| 597 "description": "Required. The resource name
of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.", |
| 598 "location": "path", |
| 599 "pattern": "^billingAccounts/[^/]+/logs/[^/]
+$", |
| 600 "required": true, |
| 601 "type": "string" |
| 602 } |
| 603 }, |
| 604 "path": "v2beta1/{+logName}", |
| 605 "response": { |
| 606 "$ref": "Empty" |
| 607 }, |
| 608 "scopes": [ |
| 609 "https://www.googleapis.com/auth/cloud-platform"
, |
| 610 "https://www.googleapis.com/auth/logging.admin" |
| 611 ] |
| 612 } |
| 613 } |
| 614 } |
| 615 } |
526 } | 616 } |
527 }, | 617 }, |
528 "revision": "20160322", | 618 "revision": "20161028", |
529 "rootUrl": "https://logging.googleapis.com/", | 619 "rootUrl": "https://logging.googleapis.com/", |
530 "schemas": { | 620 "schemas": { |
531 "Empty": { | 621 "ListLogEntriesResponse": { |
532 "description": "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 re
presentation for `Empty` is empty JSON object `{}`.", | 622 "description": "Result returned from `ListLogEntries`.", |
533 "id": "Empty", | 623 "id": "ListLogEntriesResponse", |
534 "type": "object" | 624 "properties": { |
535 }, | |
536 "WriteLogEntriesRequest": { | |
537 "description": "The parameters to WriteLogEntries.", | |
538 "id": "WriteLogEntriesRequest", | |
539 "properties": { | |
540 "logName": { | |
541 "description": "Optional. A default log resource name for th
ose log entries in `entries` that do not specify their own `logName`. Example: `
\"projects/my-project/logs/syslog\"`. See LogEntry.", | |
542 "type": "string" | |
543 }, | |
544 "resource": { | |
545 "$ref": "MonitoredResource", | |
546 "description": "Optional. A default monitored resource for t
hose log entries in `entries` that do not specify their own `resource`." | |
547 }, | |
548 "labels": { | |
549 "additionalProperties": { | |
550 "type": "string" | |
551 }, | |
552 "description": "Optional. User-defined `key:value` items tha
t are added to the `labels` field of each log entry in `entries`, except when a
log entry specifies its own `key:value` item with the same key. Example: `{ \"si
ze\": \"large\", \"color\":\"red\" }`", | |
553 "type": "object" | |
554 }, | |
555 "entries": { | 625 "entries": { |
556 "description": "Required. The log entries to write. The log
entries must have values for all required fields.", | 626 "description": "A list of log entries.", |
557 "items": { | 627 "items": { |
558 "$ref": "LogEntry" | 628 "$ref": "LogEntry" |
559 }, | 629 }, |
560 "type": "array" | 630 "type": "array" |
561 }, | 631 }, |
562 "partialSuccess": { | 632 "nextPageToken": { |
563 "description": "Optional. Whether valid entries should be wr
itten even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENI
ED errors. If any entry is not written, the response status will be the error as
sociated with one of the failed entries and include error details in the form of
WriteLogEntriesPartialErrors.", | 633 "description": "If there might be more results than appear i
n this response, then\n`nextPageToken` is included. To get the next set of resu
lts, call this\nmethod again using the value of `nextPageToken` as `pageToken`."
, |
564 "type": "boolean" | 634 "type": "string" |
565 } | 635 } |
566 }, | 636 }, |
567 "type": "object" | 637 "type": "object" |
568 }, | 638 }, |
569 "MonitoredResource": { | 639 "ListSinksResponse": { |
570 "description": "An object representing a resource that can be used f
or monitoring, logging, billing, or other purposes. Examples include virtual mac
hine instances, databases, and storage devices such as disks. The `type` field i
dentifies a MonitoredResourceDescriptor object that describes the resource's sch
ema. Information in the `labels` field identifies the actual resource and its at
tributes according to the schema. For example, a particular Compute Engine VM in
stance could be represented by the following object, because the MonitoredResour
ceDescriptor for `\"gce_instance\"` has labels `\"instance_id\"` and `\"zone\"`:
{ \"type\": \"gce_instance\", \"labels\": { \"instance_id\": \"my-instance\", \
"zone\": \"us-central1-a\" }}", | 640 "description": "Result returned from `ListSinks`.", |
571 "id": "MonitoredResource", | 641 "id": "ListSinksResponse", |
572 "properties": { | 642 "properties": { |
573 "type": { | 643 "nextPageToken": { |
574 "description": "Required. The monitored resource type. This
field must match the `type` field of a MonitoredResourceDescriptor object. For e
xample, the type of a Cloud SQL database is `\"cloudsql_database\"`.", | 644 "description": "If there might be more results than appear i
n this response, then\n`nextPageToken` is included. To get the next set of resu
lts, call the same\nmethod again using the value of `nextPageToken` as `pageToke
n`.", |
575 "type": "string" | 645 "type": "string" |
576 }, | 646 }, |
577 "labels": { | 647 "sinks": { |
578 "additionalProperties": { | 648 "description": "A list of sinks.", |
579 "type": "string" | 649 "items": { |
580 }, | 650 "$ref": "LogSink" |
581 "description": "Required. Values for all of the labels liste
d in the associated monitored resource descriptor. For example, Cloud SQL databa
ses use the labels `\"database_id\"` and `\"zone\"`.", | 651 }, |
582 "type": "object" | 652 "type": "array" |
| 653 } |
| 654 }, |
| 655 "type": "object" |
| 656 }, |
| 657 "SourceLocation": { |
| 658 "description": "Specifies a location in a source code file.", |
| 659 "id": "SourceLocation", |
| 660 "properties": { |
| 661 "file": { |
| 662 "description": "Source file name. Depending on the runtime e
nvironment, this might be a\nsimple name or a fully-qualified name.", |
| 663 "type": "string" |
| 664 }, |
| 665 "functionName": { |
| 666 "description": "Human-readable name of the function or metho
d being invoked, with optional\ncontext such as the class or package name. This
information is used in\ncontexts such as the logs viewer, where a file and line
number are less\nmeaningful. The format can vary by language. For example:\n`qua
l.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`\n(Python).", |
| 667 "type": "string" |
| 668 }, |
| 669 "line": { |
| 670 "description": "Line within the source file.", |
| 671 "format": "int64", |
| 672 "type": "string" |
| 673 } |
| 674 }, |
| 675 "type": "object" |
| 676 }, |
| 677 "LogSink": { |
| 678 "description": "Describes a sink used to export log entries outside
of Stackdriver Logging.\nA logs filter controls which log entries are exported.
Sinks can have a\nstart time and an end time; these can be used to place log en
tries from an\nexact time range into a particular destination. If both `start_t
ime` and\n`end_time` are present, then `start_time` must be less than `end_time`
.", |
| 679 "id": "LogSink", |
| 680 "properties": { |
| 681 "destination": { |
| 682 "description": "Required. The export destination. See\n[Expo
rting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).\nExamples:\n\n
\"storage.googleapis.com/my-gcs-bucket\"\n \"bigquery.googleapis.com/projec
ts/my-project-id/datasets/my-dataset\"\n \"pubsub.googleapis.com/projects/my-
project/topics/my-topic\"", |
| 683 "type": "string" |
| 684 }, |
| 685 "filter": { |
| 686 "description": "Optional. An [advanced logs filter](/logging
/docs/view/advanced_filters).\nOnly log entries matching the filter are exported
. The filter\nmust be consistent with the log entry format specified by the\n`ou
tputVersionFormat` parameter, regardless of the format of the\nlog entry that wa
s originally written to Stackdriver Logging.\nExample filter (V2 format):\n\n
logName=projects/my-projectid/logs/syslog AND severity>=ERROR", |
| 687 "type": "string" |
| 688 }, |
| 689 "endTime": { |
| 690 "description": "Optional. Time at which this sink will stop
exporting log entries. If this\nvalue is present, then log entries are exported
only if `entry.timestamp` <\n`end_time`.", |
| 691 "format": "google-datetime", |
| 692 "type": "string" |
| 693 }, |
| 694 "name": { |
| 695 "description": "Required. The client-assigned sink identifie
r, unique within the\nproject. Example: `\"my-syslog-errors-to-pubsub\"`. Sink
identifiers are\nlimited to 1000 characters and can include only the following c
haracters:\n`A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum
length\nof the name is 100 characters.", |
| 696 "type": "string" |
| 697 }, |
| 698 "startTime": { |
| 699 "description": "Optional. The time at which this sink will b
egin exporting log entries. If\nthis value is present, then log entries are exp
orted only if `start_time`\n<=`entry.timestamp`.", |
| 700 "format": "google-datetime", |
| 701 "type": "string" |
| 702 }, |
| 703 "outputVersionFormat": { |
| 704 "description": "Optional. The log entry version to use for t
his sink's exported log\nentries. This version does not have to correspond to t
he version of the\nlog entry that was written to Stackdriver Logging. If omitted
, the\nv2 format is used.", |
| 705 "enum": [ |
| 706 "VERSION_FORMAT_UNSPECIFIED", |
| 707 "V2", |
| 708 "V1" |
| 709 ], |
| 710 "enumDescriptions": [ |
| 711 "An unspecified version format will default to V2.", |
| 712 "`LogEntry` version 2 format.", |
| 713 "`LogEntry` version 1 format." |
| 714 ], |
| 715 "type": "string" |
| 716 }, |
| 717 "writerIdentity": { |
| 718 "description": "Output only. An IAM identity—a service
account or group—that\nwill write exported log entries to the destination
on behalf of Stackdriver\nLogging. You must grant this identity write-access to
the destination.\nConsult the destination service's documentation to determine
the exact role\nthat must be granted.", |
| 719 "type": "string" |
| 720 } |
| 721 }, |
| 722 "type": "object" |
| 723 }, |
| 724 "LogMetric": { |
| 725 "description": "Describes a logs-based metric. The value of the met
ric is the\nnumber of log entries that match a logs filter.", |
| 726 "id": "LogMetric", |
| 727 "properties": { |
| 728 "description": { |
| 729 "description": "Optional. A description of this metric, whic
h is used in documentation.", |
| 730 "type": "string" |
| 731 }, |
| 732 "filter": { |
| 733 "description": "Required. An [advanced logs filter](/logging
/docs/view/advanced_filters).\nExample: `\"resource.type=gae_app AND severity>=E
RROR\"`.", |
| 734 "type": "string" |
| 735 }, |
| 736 "name": { |
| 737 "description": "Required. The client-assigned metric identif
ier. Example:\n`\"severe_errors\"`. Metric identifiers are limited to 100\nchar
acters and can include only the following characters: `A-Z`,\n`a-z`, `0-9`, and
the special characters `_-.,+!*',()%/`. The\nforward-slash character (`/`) deno
tes a hierarchy of name pieces,\nand it cannot be the first character of the nam
e. The '%' character\nis used to URL encode unsafe and reserved characters and
must be\nfollowed by two hexadecimal digits according to RFC 1738.", |
| 738 "type": "string" |
| 739 }, |
| 740 "version": { |
| 741 "description": "Output only. The API version that created or
updated this metric.\nThe version also dictates the syntax of the filter expres
sion. When a value\nfor this field is missing, the default value of V2 should be
assumed.", |
| 742 "enum": [ |
| 743 "V2", |
| 744 "V1" |
| 745 ], |
| 746 "enumDescriptions": [ |
| 747 "Stackdriver Logging API v2.", |
| 748 "Stackdriver Logging API v1." |
| 749 ], |
| 750 "type": "string" |
583 } | 751 } |
584 }, | 752 }, |
585 "type": "object" | 753 "type": "object" |
586 }, | 754 }, |
587 "LogEntry": { | 755 "LogEntry": { |
588 "description": "An individual entry in a log.", | 756 "description": "An individual entry in a log.", |
589 "id": "LogEntry", | 757 "id": "LogEntry", |
590 "properties": { | 758 "properties": { |
591 "logName": { | |
592 "description": "Required. The resource name of the log to wh
ich this log entry belongs. The format of the name is `\"projects/\n/logs/\"`. E
xamples: `\"projects/my-projectid/logs/syslog\"`, `\"projects/1234567890/logs/li
brary.googleapis.com%2Fbook_log\"`. The log ID part of resource name must be les
s than 512 characters long and can only include the following characters: upper
and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters:
forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters i
n the log ID must be URL-encoded.", | |
593 "type": "string" | |
594 }, | |
595 "resource": { | |
596 "$ref": "MonitoredResource", | |
597 "description": "Required. The monitored resource associated
with this log entry. Example: a log entry that reports a database error would be
associated with the monitored resource designating the particular database that
reported the error." | |
598 }, | |
599 "protoPayload": { | |
600 "additionalProperties": { | |
601 "description": "Properties of the object. Contains field
@ype with type URL.", | |
602 "type": "any" | |
603 }, | |
604 "description": "The log entry payload, represented as a prot
ocol buffer. You can only use `protoPayload` values that belong to a set of appr
oved types.", | |
605 "type": "object" | |
606 }, | |
607 "textPayload": { | 759 "textPayload": { |
608 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", | 760 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", |
609 "type": "string" | 761 "type": "string" |
610 }, | 762 }, |
| 763 "httpRequest": { |
| 764 "$ref": "HttpRequest", |
| 765 "description": "Optional. Information about the HTTP request
associated with this\nlog entry, if applicable." |
| 766 }, |
611 "jsonPayload": { | 767 "jsonPayload": { |
612 "additionalProperties": { | 768 "additionalProperties": { |
613 "description": "Properties of the object.", | 769 "description": "Properties of the object.", |
614 "type": "any" | 770 "type": "any" |
615 }, | 771 }, |
616 "description": "The log entry payload, represented as a stru
cture that is expressed as a JSON object.", | 772 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", |
617 "type": "object" | 773 "type": "object" |
618 }, | 774 }, |
619 "timestamp": { | 775 "labels": { |
620 "description": "Optional. The time the event described by th
e log entry occurred. If omitted, Cloud Logging will use the time the log entry
is written.", | 776 "additionalProperties": { |
| 777 "type": "string" |
| 778 }, |
| 779 "description": "Optional. A set of user-defined (key, value)
data that provides additional\ninformation about the log entry.", |
| 780 "type": "object" |
| 781 }, |
| 782 "logName": { |
| 783 "description": "Required. The resource name of the log to wh
ich this log entry\nbelongs. The format of the name is\n`\"projects/<project-id>
/logs/<log-id>\"`. Examples:\n`\"projects/my-projectid/logs/syslog\"`,\n`\"proj
ects/my-projectid/logs/library.googleapis.com%2Fbook_log\"`.\n\nThe log ID part
of resource name must be less than 512 characters\nlong and can only include the
following characters: upper and\nlower case alphanumeric characters: [A-Za-z0-9
]; and punctuation\ncharacters: forward-slash, underscore, hyphen, and period.\n
Forward-slash (`/`) characters in the log ID must be URL-encoded.", |
621 "type": "string" | 784 "type": "string" |
622 }, | 785 }, |
623 "severity": { | 786 "severity": { |
624 "description": "Optional. The severity of the log entry. The
default value is `LogSeverity.DEFAULT`.", | 787 "description": "Optional. The severity of the log entry. The
default value is\n`LogSeverity.DEFAULT`.", |
625 "enum": [ | 788 "enum": [ |
626 "DEFAULT", | 789 "DEFAULT", |
627 "DEBUG", | 790 "DEBUG", |
628 "INFO", | 791 "INFO", |
629 "NOTICE", | 792 "NOTICE", |
630 "WARNING", | 793 "WARNING", |
631 "ERROR", | 794 "ERROR", |
632 "CRITICAL", | 795 "CRITICAL", |
633 "ALERT", | 796 "ALERT", |
634 "EMERGENCY" | 797 "EMERGENCY" |
635 ], | 798 ], |
| 799 "enumDescriptions": [ |
| 800 "(0) The log entry has no assigned severity level.", |
| 801 "(100) Debug or trace information.", |
| 802 "(200) Routine information, such as ongoing status or pe
rformance.", |
| 803 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", |
| 804 "(400) Warning events might cause problems.", |
| 805 "(500) Error events are likely to cause problems.", |
| 806 "(600) Critical events cause more severe problems or out
ages.", |
| 807 "(700) A person must take an action immediately.", |
| 808 "(800) One or more systems are unusable." |
| 809 ], |
| 810 "type": "string" |
| 811 }, |
| 812 "resource": { |
| 813 "$ref": "MonitoredResource", |
| 814 "description": "Required. The monitored resource associated
with this log entry.\nExample: a log entry that reports a database error would b
e\nassociated with the monitored resource designating the particular\ndatabase t
hat reported the error." |
| 815 }, |
| 816 "protoPayload": { |
| 817 "additionalProperties": { |
| 818 "description": "Properties of the object. Contains field
@type with type URL.", |
| 819 "type": "any" |
| 820 }, |
| 821 "description": "The log entry payload, represented as a prot
ocol buffer. Some\nGoogle Cloud Platform services use this field for their log\
nentry payloads.", |
| 822 "type": "object" |
| 823 }, |
| 824 "timestamp": { |
| 825 "description": "Optional. The time the event described by th
e log entry occurred. If\nomitted, Stackdriver Logging will use the time the lo
g entry is received.", |
| 826 "format": "google-datetime", |
636 "type": "string" | 827 "type": "string" |
637 }, | 828 }, |
638 "insertId": { | 829 "insertId": { |
639 "description": "Optional. A unique ID for the log entry. If
you provide this field, the logging service considers other log entries in the s
ame log with the same ID as duplicates which can be removed. If omitted, Cloud L
ogging will generate a unique ID for this log entry.", | 830 "description": "Optional. A unique ID for the log entry. If
you provide this\nfield, the logging service considers other log entries in the\
nsame project with the same ID as duplicates which can be removed. If\nomitted,
Stackdriver Logging will generate a unique ID for this\nlog entry.", |
640 "type": "string" | 831 "type": "string" |
641 }, | 832 }, |
642 "httpRequest": { | 833 "operation": { |
643 "$ref": "HttpRequest", | 834 "$ref": "LogEntryOperation", |
644 "description": "Optional. Information about the HTTP request
associated with this log entry, if applicable." | 835 "description": "Optional. Information about an operation ass
ociated with the log entry, if\napplicable." |
645 }, | 836 } |
| 837 }, |
| 838 "type": "object" |
| 839 }, |
| 840 "LogLine": { |
| 841 "description": "Application log line emitted while processing a requ
est.", |
| 842 "id": "LogLine", |
| 843 "properties": { |
| 844 "time": { |
| 845 "description": "Approximate time when this log entry was mad
e.", |
| 846 "format": "google-datetime", |
| 847 "type": "string" |
| 848 }, |
| 849 "severity": { |
| 850 "description": "Severity of this log entry.", |
| 851 "enum": [ |
| 852 "DEFAULT", |
| 853 "DEBUG", |
| 854 "INFO", |
| 855 "NOTICE", |
| 856 "WARNING", |
| 857 "ERROR", |
| 858 "CRITICAL", |
| 859 "ALERT", |
| 860 "EMERGENCY" |
| 861 ], |
| 862 "enumDescriptions": [ |
| 863 "(0) The log entry has no assigned severity level.", |
| 864 "(100) Debug or trace information.", |
| 865 "(200) Routine information, such as ongoing status or pe
rformance.", |
| 866 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", |
| 867 "(400) Warning events might cause problems.", |
| 868 "(500) Error events are likely to cause problems.", |
| 869 "(600) Critical events cause more severe problems or out
ages.", |
| 870 "(700) A person must take an action immediately.", |
| 871 "(800) One or more systems are unusable." |
| 872 ], |
| 873 "type": "string" |
| 874 }, |
| 875 "sourceLocation": { |
| 876 "$ref": "SourceLocation", |
| 877 "description": "Where in the source code this log message wa
s written." |
| 878 }, |
| 879 "logMessage": { |
| 880 "description": "App-provided log message.", |
| 881 "type": "string" |
| 882 } |
| 883 }, |
| 884 "type": "object" |
| 885 }, |
| 886 "SourceReference": { |
| 887 "description": "A reference to a particular snapshot of the source t
ree used to build and\ndeploy an application.", |
| 888 "id": "SourceReference", |
| 889 "properties": { |
| 890 "repository": { |
| 891 "description": "Optional. A URI string identifying the repos
itory.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", |
| 892 "type": "string" |
| 893 }, |
| 894 "revisionId": { |
| 895 "description": "The canonical and persistent identifier of t
he deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b
\"", |
| 896 "type": "string" |
| 897 } |
| 898 }, |
| 899 "type": "object" |
| 900 }, |
| 901 "MonitoredResource": { |
| 902 "description": "An object representing a resource that can be used f
or monitoring, logging,\nbilling, or other purposes. Examples include virtual ma
chine instances,\ndatabases, and storage devices such as disks. The `type` field
identifies a\nMonitoredResourceDescriptor object that describes the resource's\
nschema. Information in the `labels` field identifies the actual resource and\ni
ts attributes according to the schema. For example, a particular Compute\nEngine
VM instance could be represented by the following object, because the\nMonitore
dResourceDescriptor for `\"gce_instance\"` has labels\n`\"instance_id\"` and `\"
zone\"`:\n\n { \"type\": \"gce_instance\",\n \"labels\": { \"instance_id
\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}", |
| 903 "id": "MonitoredResource", |
| 904 "properties": { |
646 "labels": { | 905 "labels": { |
647 "additionalProperties": { | 906 "additionalProperties": { |
648 "type": "string" | 907 "type": "string" |
649 }, | 908 }, |
650 "description": "Optional. A set of user-defined (key, value)
data that provides additional information about the log entry.", | 909 "description": "Required. Values for all of the labels liste
d in the associated monitored\nresource descriptor. For example, Cloud SQL datab
ases use the labels\n`\"database_id\"` and `\"zone\"`.", |
651 "type": "object" | 910 "type": "object" |
652 }, | 911 }, |
653 "operation": { | 912 "type": { |
654 "$ref": "LogEntryOperation", | 913 "description": "Required. The monitored resource type. This
field must match\nthe `type` field of a MonitoredResourceDescriptor object. For\
nexample, the type of a Cloud SQL database is `\"cloudsql_database\"`.", |
655 "description": "Optional. Information about an operation ass
ociated with the log entry, if applicable." | 914 "type": "string" |
656 } | 915 } |
657 }, | 916 }, |
658 "type": "object" | 917 "type": "object" |
659 }, | 918 }, |
660 "HttpRequest": { | 919 "WriteLogEntriesRequest": { |
661 "description": "A common proto for logging HTTP requests.", | 920 "description": "The parameters to WriteLogEntries.", |
662 "id": "HttpRequest", | 921 "id": "WriteLogEntriesRequest", |
663 "properties": { | 922 "properties": { |
664 "requestMethod": { | 923 "labels": { |
665 "description": "The request method. Examples: `\"GET\"`, `\"
HEAD\"`, `\"PUT\"`, `\"POST\"`.", | 924 "additionalProperties": { |
666 "type": "string" | |
667 }, | |
668 "requestUrl": { | |
669 "description": "The scheme (http, https), the host name, the
path and the query portion of the URL that was requested. Example: `\"http://ex
ample.com/some/info?color=red\"`.", | |
670 "type": "string" | |
671 }, | |
672 "requestSize": { | |
673 "description": "The size of the HTTP request message in byte
s, including the request headers and the request body.", | |
674 "format": "int64", | |
675 "type": "string" | |
676 }, | |
677 "status": { | |
678 "description": "The response code indicating the status of r
esponse. Examples: 200, 404.", | |
679 "format": "int32", | |
680 "type": "integer" | |
681 }, | |
682 "responseSize": { | |
683 "description": "The size of the HTTP response message sent b
ack to the client, in bytes, including the response headers and the response bod
y.", | |
684 "format": "int64", | |
685 "type": "string" | |
686 }, | |
687 "userAgent": { | |
688 "description": "The user agent sent by the client. Example:
`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`
.", | |
689 "type": "string" | |
690 }, | |
691 "remoteIp": { | |
692 "description": "The IP address (IPv4 or IPv6) of the client
that issued the HTTP request. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE
1E:8329\"`.", | |
693 "type": "string" | |
694 }, | |
695 "referer": { | |
696 "description": "The referer URL of the request, as defined i
n [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc261
6-sec14.html).", | |
697 "type": "string" | |
698 }, | |
699 "cacheLookup": { | |
700 "description": "Whether or not a cache lookup was attempted.
", | |
701 "type": "boolean" | |
702 }, | |
703 "cacheHit": { | |
704 "description": "Whether or not an entity was served from cac
he (with or without validation).", | |
705 "type": "boolean" | |
706 }, | |
707 "cacheValidatedWithOriginServer": { | |
708 "description": "Whether or not the response was validated wi
th the origin server before being served from cache. This field is only meaningf
ul if `cache_hit` is True.", | |
709 "type": "boolean" | |
710 }, | |
711 "cacheFillBytes": { | |
712 "description": "The number of HTTP response bytes inserted i
nto cache. Set only when a cache fill was attempted.", | |
713 "format": "int64", | |
714 "type": "string" | |
715 } | |
716 }, | |
717 "type": "object" | |
718 }, | |
719 "LogEntryOperation": { | |
720 "description": "Additional information about a potentially long-runn
ing operation with which a log entry is associated.", | |
721 "id": "LogEntryOperation", | |
722 "properties": { | |
723 "id": { | |
724 "description": "Required. An arbitrary operation identifier.
Log entries with the same identifier are assumed to be part of the same operati
on.", | |
725 "type": "string" | |
726 }, | |
727 "producer": { | |
728 "description": "Required. An arbitrary producer identifier.
The combination of `id` and `producer` must be globally unique. Examples for `pr
oducer`: `\"MyDivision.MyBigCompany.com\"`, \"github.com/MyProject/MyApplication
\"`.", | |
729 "type": "string" | |
730 }, | |
731 "first": { | |
732 "description": "Optional. Set this to True if this is the fi
rst log entry in the operation.", | |
733 "type": "boolean" | |
734 }, | |
735 "last": { | |
736 "description": "Optional. Set this to True if this is the la
st log entry in the operation.", | |
737 "type": "boolean" | |
738 } | |
739 }, | |
740 "type": "object" | |
741 }, | |
742 "WriteLogEntriesResponse": { | |
743 "description": "Result returned from WriteLogEntries. empty", | |
744 "id": "WriteLogEntriesResponse", | |
745 "type": "object" | |
746 }, | |
747 "ListLogEntriesRequest": { | |
748 "description": "The parameters to `ListLogEntries`.", | |
749 "id": "ListLogEntriesRequest", | |
750 "properties": { | |
751 "projectIds": { | |
752 "description": "Required. One or more project IDs or project
numbers from which to retrieve log entries. Examples of a project ID: `\"my-pro
ject-1A\"`, `\"1234567890\"`.", | |
753 "items": { | |
754 "type": "string" | 925 "type": "string" |
755 }, | 926 }, |
756 "type": "array" | 927 "description": "Optional. Default labels that are added to t
he `labels` field of all log\nentries in `entries`. If a log entry already has a
label with the same key\nas a label in this parameter, then the log entry's lab
el is not changed.\nSee LogEntry.", |
757 }, | 928 "type": "object" |
758 "filter": { | 929 }, |
759 "description": "Optional. An [advanced logs filter](/logging
/docs/view/advanced_filters). The filter is compared against all log entries in
the projects specified by `projectIds`. Only entries that match the filter are r
etrieved. An empty filter matches all log entries.", | |
760 "type": "string" | |
761 }, | |
762 "orderBy": { | |
763 "description": "Optional. How the results should be sorted.
Presently, the only permitted values are `\"timestamp asc\"` (default) and `\"ti
mestamp desc\"`. The first option returns entries in order of increasing values
of `LogEntry.timestamp` (oldest first), and the second option returns entries in
order of decreasing timestamps (newest first). Entries with equal timestamps ar
e returned in order of `LogEntry.insertId`.", | |
764 "type": "string" | |
765 }, | |
766 "pageSize": { | |
767 "description": "Optional. The maximum number of results to r
eturn from this request. You must check for presence of `nextPageToken` to deter
mine if additional results are available, which you can retrieve by passing the
`nextPageToken` value as the `pageToken` parameter in the next request.", | |
768 "format": "int32", | |
769 "type": "integer" | |
770 }, | |
771 "pageToken": { | |
772 "description": "Optional. If the `pageToken` parameter is su
pplied, then the next page of results is retrieved. The `pageToken` parameter mu
st be set to the value of the `nextPageToken` from the previous response. The va
lues of `projectIds`, `filter`, and `orderBy` must be the same as in the previou
s request.", | |
773 "type": "string" | |
774 }, | |
775 "partialSuccess": { | |
776 "description": "Optional. If true, read access to all projec
ts is not required and results will be returned for the subset of projects for w
hich read access is permitted (empty subset is permitted).", | |
777 "type": "boolean" | |
778 } | |
779 }, | |
780 "type": "object" | |
781 }, | |
782 "ListLogEntriesResponse": { | |
783 "description": "Result returned from `ListLogEntries`.", | |
784 "id": "ListLogEntriesResponse", | |
785 "properties": { | |
786 "entries": { | 930 "entries": { |
787 "description": "A list of log entries.", | 931 "description": "Required. The log entries to write. Values s
upplied for the fields\n`log_name`, `resource`, and `labels` in this `entries.wr
ite` request are\nadded to those log entries that do not provide their own value
s for the\nfields.\n\nTo improve throughput and to avoid exceeding the\n[quota l
imit](/logging/quota-policy) for calls to `entries.write`,\nyou should write mul
tiple log entries at once rather than\ncalling this method for each individual l
og entry.", |
788 "items": { | 932 "items": { |
789 "$ref": "LogEntry" | 933 "$ref": "LogEntry" |
790 }, | 934 }, |
791 "type": "array" | 935 "type": "array" |
792 }, | 936 }, |
793 "nextPageToken": { | 937 "logName": { |
794 "description": "If there are more results than were returned
, then `nextPageToken` is included in the response. To get the next set of resul
ts, call this method again using the value of `nextPageToken` as `pageToken`.", | 938 "description": "Optional. A default log resource name that i
s assigned to all log entries\nin `entries` that do not specify a value for `log
_name`. Example:\n`\"projects/my-project/logs/syslog\"`. See\nLogEntry.", |
795 "type": "string" | 939 "type": "string" |
796 }, | 940 }, |
797 "projectIdErrors": { | 941 "partialSuccess": { |
798 "additionalProperties": { | 942 "description": "Optional. Whether valid entries should be wr
itten even if some other\nentries fail due to INVALID_ARGUMENT or PERMISSION_DEN
IED errors. If any\nentry is not written, the response status will be the error
associated\nwith one of the failed entries and include error details in the form
of\nWriteLogEntriesPartialErrors.", |
799 "$ref": "Status" | 943 "type": "boolean" |
800 }, | 944 }, |
801 "description": "If partial_success is true, contains the pro
ject ids that had errors and the associated errors.", | 945 "resource": { |
802 "type": "object" | 946 "$ref": "MonitoredResource", |
803 } | 947 "description": "Optional. A default monitored resource objec
t that is assigned to all log\nentries in `entries` that do not specify a value
for `resource`. Example:\n\n { \"type\": \"gce_instance\",\n \"labels\":
{\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000
\" }}\n\nSee LogEntry." |
804 }, | |
805 "type": "object" | |
806 }, | |
807 "Status": { | |
808 "description": "The `Status` type defines a logical error model that
is suitable for different programming environments, including REST APIs and RPC
APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of google.rpc.Code, but it may accept additional error codes if needed. Th
e error message should be a developer-facing English message that helps develope
rs *understand* and *resolve* the error. If a localized user-facing error messag
e is needed, put the localized message in the error details or localize it in th
e client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.r
pc` which can be used for common error conditions. # Language mapping The `Statu
s` message is the logical representation of the error model, but it is not neces
sarily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. Fo
r example, it will likely be mapped to some exceptions in Java, but more likely
mapped to some error codes in C. # Other uses The error model and the `Status` m
essage can be used in a variety of environments, either with or without APIs, to
provide a consistent developer experience across different environments. Exampl
e uses of this error model include: - Partial errors. If a service needs to retu
rn partial errors to the client, it may embed the `Status` in the normal respons
e to indicate the partial errors. - Workflow errors. A typical workflow has mult
iple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Statu
s` message should be used directly inside batch response, one for each error sub
-response. - Asynchronous operations. If an API call embeds asynchronous operati
on results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored i
n logs, the message `Status` could be used directly after any stripping needed f
or security/privacy reasons.", | |
809 "id": "Status", | |
810 "properties": { | |
811 "code": { | |
812 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
813 "format": "int32", | |
814 "type": "integer" | |
815 }, | |
816 "message": { | |
817 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the google.rpc.Status.details field, or localized by the client.", | |
818 "type": "string" | |
819 }, | |
820 "details": { | |
821 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", | |
822 "items": { | |
823 "additionalProperties": { | |
824 "description": "Properties of the object. Contains f
ield @ype with type URL.", | |
825 "type": "any" | |
826 }, | |
827 "type": "object" | |
828 }, | |
829 "type": "array" | |
830 } | |
831 }, | |
832 "type": "object" | |
833 }, | |
834 "ListMonitoredResourceDescriptorsResponse": { | |
835 "description": "Result returned from ListMonitoredResourceDescriptor
s.", | |
836 "id": "ListMonitoredResourceDescriptorsResponse", | |
837 "properties": { | |
838 "resourceDescriptors": { | |
839 "description": "A list of resource descriptors.", | |
840 "items": { | |
841 "$ref": "MonitoredResourceDescriptor" | |
842 }, | |
843 "type": "array" | |
844 }, | |
845 "nextPageToken": { | |
846 "description": "If there are more results than were returned
, then `nextPageToken` is included in the response. To get the next set of resul
ts, call this method again using the value of `nextPageToken` as `pageToken`.", | |
847 "type": "string" | |
848 } | |
849 }, | |
850 "type": "object" | |
851 }, | |
852 "MonitoredResourceDescriptor": { | |
853 "description": "An object that describes the schema of a MonitoredRe
source 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 monit
ored resource types. APIs generally provide a `list` method that returns the mon
itored resource descriptors used by the API.", | |
854 "id": "MonitoredResourceDescriptor", | |
855 "properties": { | |
856 "name": { | |
857 "description": "Optional. The resource name of the monitored
resource descriptor: `\"projects/{project_id}/monitoredResourceDescriptors/{typ
e}\"` 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. A
PIs that do not use project information can use the resource name format `\"moni
toredResourceDescriptors/{type}\"`.", | |
858 "type": "string" | |
859 }, | |
860 "type": { | |
861 "description": "Required. The monitored resource type. For e
xample, the type `\"cloudsql_database\"` represents databases in Google Cloud SQ
L.", | |
862 "type": "string" | |
863 }, | |
864 "displayName": { | |
865 "description": "Optional. A concise name for the monitored r
esource type that might be displayed in user interfaces. For example, `\"Google
Cloud SQL Database\"`.", | |
866 "type": "string" | |
867 }, | |
868 "description": { | |
869 "description": "Optional. A detailed description of the moni
tored resource type that might be used in documentation.", | |
870 "type": "string" | |
871 }, | |
872 "labels": { | |
873 "description": "Required. A set of labels used to describe i
nstances of this monitored resource type. For example, an individual Google Clou
d SQL database is identified by values for the labels `\"database_id\"` and `\"z
one\"`.", | |
874 "items": { | |
875 "$ref": "LabelDescriptor" | |
876 }, | |
877 "type": "array" | |
878 } | 948 } |
879 }, | 949 }, |
880 "type": "object" | 950 "type": "object" |
881 }, | 951 }, |
882 "LabelDescriptor": { | 952 "LabelDescriptor": { |
883 "description": "A description of a label.", | 953 "description": "A description of a label.", |
884 "id": "LabelDescriptor", | 954 "id": "LabelDescriptor", |
885 "properties": { | 955 "properties": { |
886 "key": { | 956 "description": { |
887 "description": "The label key.", | 957 "description": "A human-readable description for the label."
, |
888 "type": "string" | 958 "type": "string" |
889 }, | 959 }, |
890 "valueType": { | 960 "valueType": { |
891 "description": "The type of data that can be assigned to the
label.", | 961 "description": "The type of data that can be assigned to the
label.", |
892 "enum": [ | 962 "enum": [ |
893 "STRING", | 963 "STRING", |
894 "BOOL", | 964 "BOOL", |
895 "INT64" | 965 "INT64" |
896 ], | 966 ], |
897 "type": "string" | 967 "enumDescriptions": [ |
898 }, | 968 "A variable-length string. This is the default.", |
899 "description": { | 969 "Boolean; true or false.", |
900 "description": "A human-readable description for the label."
, | 970 "A 64-bit signed integer." |
901 "type": "string" | 971 ], |
902 } | 972 "type": "string" |
903 }, | 973 }, |
904 "type": "object" | 974 "key": { |
905 }, | 975 "description": "The label key.", |
906 "ListSinksResponse": { | |
907 "description": "Result returned from `ListSinks`.", | |
908 "id": "ListSinksResponse", | |
909 "properties": { | |
910 "sinks": { | |
911 "description": "A list of sinks.", | |
912 "items": { | |
913 "$ref": "LogSink" | |
914 }, | |
915 "type": "array" | |
916 }, | |
917 "nextPageToken": { | |
918 "description": "If there are more results than were returned
, then `nextPageToken` is included in the response. To get the next set of resul
ts, call this method again using the value of `nextPageToken` as `pageToken`.", | |
919 "type": "string" | |
920 } | |
921 }, | |
922 "type": "object" | |
923 }, | |
924 "LogSink": { | |
925 "description": "Describes a sink used to export log entries outside
Cloud Logging.", | |
926 "id": "LogSink", | |
927 "properties": { | |
928 "name": { | |
929 "description": "Required. The client-assigned sink identifie
r. Example: `\"my-severe-errors-to-pubsub\"`. Sink identifiers are limited to 10
00 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`
, and the special characters `_-.`.", | |
930 "type": "string" | |
931 }, | |
932 "destination": { | |
933 "description": "The export destination. See [Exporting Logs
With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `\"storage.google
apis.com/a-bucket\"`, `\"bigquery.googleapis.com/projects/a-project-id/datasets/
a-dataset\"`.", | |
934 "type": "string" | |
935 }, | |
936 "filter": { | |
937 "description": "An [advanced logs filter](/logging/docs/view
/advanced_filters). Only log entries matching that filter are exported. The filt
er must be consistent with the log entry format specified by the `outputVersionF
ormat` parameter, regardless of the format of the log entry that was originally
written to Cloud Logging. Example (V2 format): `\"logName=projects/my-projectid/
logs/syslog AND severity>=ERROR\"`.", | |
938 "type": "string" | |
939 }, | |
940 "outputVersionFormat": { | |
941 "description": "The log entry version to use for this sink's
exported log entries. This version does not have to correspond to the version o
f the log entry when it was written to Cloud Logging.", | |
942 "enum": [ | |
943 "VERSION_FORMAT_UNSPECIFIED", | |
944 "V2", | |
945 "V1" | |
946 ], | |
947 "type": "string" | 976 "type": "string" |
948 } | 977 } |
949 }, | 978 }, |
950 "type": "object" | 979 "type": "object" |
951 }, | 980 }, |
952 "ListLogMetricsResponse": { | 981 "ListLogMetricsResponse": { |
953 "description": "Result returned from ListLogMetrics.", | 982 "description": "Result returned from ListLogMetrics.", |
954 "id": "ListLogMetricsResponse", | 983 "id": "ListLogMetricsResponse", |
955 "properties": { | 984 "properties": { |
956 "metrics": { | 985 "metrics": { |
957 "description": "A list of logs-based metrics.", | 986 "description": "A list of logs-based metrics.", |
958 "items": { | 987 "items": { |
959 "$ref": "LogMetric" | 988 "$ref": "LogMetric" |
960 }, | 989 }, |
961 "type": "array" | 990 "type": "array" |
962 }, | 991 }, |
963 "nextPageToken": { | 992 "nextPageToken": { |
964 "description": "If there are more results than were returned
, then `nextPageToken` is included in the response. To get the next set of resul
ts, call this method again using the value of `nextPageToken` as `pageToken`.", | 993 "description": "If there might be more results than appear i
n this response, then\n`nextPageToken` is included. To get the next set of resu
lts, call this\nmethod again using the value of `nextPageToken` as `pageToken`."
, |
965 "type": "string" | 994 "type": "string" |
966 } | 995 } |
967 }, | 996 }, |
968 "type": "object" | 997 "type": "object" |
969 }, | 998 }, |
970 "LogMetric": { | 999 "MonitoredResourceDescriptor": { |
971 "description": "Describes a logs-based metric. The value of the metr
ic is the number of log entries that match a logs filter.", | 1000 "description": "An object that describes the schema of a MonitoredRe
source object using a\ntype name and a set of labels. For example, the monitore
d resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"
gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zo
ne\"` to identify particular VM instances.\n\nDifferent APIs can support differe
nt monitored resource types. APIs generally\nprovide a `list` method that return
s the monitored resource descriptors used\nby the API.", |
972 "id": "LogMetric", | 1001 "id": "MonitoredResourceDescriptor", |
973 "properties": { | 1002 "properties": { |
| 1003 "displayName": { |
| 1004 "description": "Optional. A concise name for the monitored r
esource type that might be\ndisplayed in user interfaces. It should be a Title C
ased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Go
ogle Cloud SQL Database\"`.", |
| 1005 "type": "string" |
| 1006 }, |
| 1007 "description": { |
| 1008 "description": "Optional. A detailed description of the moni
tored resource type that might\nbe used in documentation.", |
| 1009 "type": "string" |
| 1010 }, |
| 1011 "labels": { |
| 1012 "description": "Required. A set of labels used to describe i
nstances of this monitored\nresource type. For example, an individual Google Clo
ud SQL database is\nidentified by values for the labels `\"database_id\"` and `\
"zone\"`.", |
| 1013 "items": { |
| 1014 "$ref": "LabelDescriptor" |
| 1015 }, |
| 1016 "type": "array" |
| 1017 }, |
| 1018 "type": { |
| 1019 "description": "Required. The monitored resource type. For e
xample, the type\n`\"cloudsql_database\"` represents databases in Google Cloud S
QL.\nThe maximum length of this value is 256 characters.", |
| 1020 "type": "string" |
| 1021 }, |
974 "name": { | 1022 "name": { |
975 "description": "Required. The client-assigned metric identif
ier. Example: `\"severe_errors\"`. Metric identifiers are limited to 1000 charac
ters 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.", | 1023 "description": "Optional. The resource name of the monitored
resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{ty
pe}\"` where\n{type} is the value of the `type` field in this object and\n{proje
ct_id} is a project ID that provides API-specific context for\naccessing the typ
e. APIs that do not use project information can use the\nresource name format `
\"monitoredResourceDescriptors/{type}\"`.", |
976 "type": "string" | 1024 "type": "string" |
977 }, | 1025 } |
978 "description": { | 1026 }, |
979 "description": "A description of this metric, which is used
in documentation.", | 1027 "type": "object" |
980 "type": "string" | 1028 }, |
981 }, | 1029 "ListMonitoredResourceDescriptorsResponse": { |
982 "filter": { | 1030 "description": "Result returned from ListMonitoredResourceDescriptor
s.", |
983 "description": "An [advanced logs filter](/logging/docs/view
/advanced_filters). Example: `\"logName:syslog AND severity>=ERROR\"`.", | 1031 "id": "ListMonitoredResourceDescriptorsResponse", |
| 1032 "properties": { |
| 1033 "nextPageToken": { |
| 1034 "description": "If there might be more results than appear i
n this response, then\n`nextPageToken` is included. To get the next set of resu
lts, call this\nmethod again using the value of `nextPageToken` as `pageToken`."
, |
| 1035 "type": "string" |
| 1036 }, |
| 1037 "resourceDescriptors": { |
| 1038 "description": "A list of resource descriptors.", |
| 1039 "items": { |
| 1040 "$ref": "MonitoredResourceDescriptor" |
| 1041 }, |
| 1042 "type": "array" |
| 1043 } |
| 1044 }, |
| 1045 "type": "object" |
| 1046 }, |
| 1047 "LogEntryOperation": { |
| 1048 "description": "Additional information about a potentially long-runn
ing operation with which\na log entry is associated.", |
| 1049 "id": "LogEntryOperation", |
| 1050 "properties": { |
| 1051 "producer": { |
| 1052 "description": "Optional. An arbitrary producer identifier.
The combination of\n`id` and `producer` must be globally unique. Examples for `
producer`:\n`\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplica
tion\"`.", |
| 1053 "type": "string" |
| 1054 }, |
| 1055 "last": { |
| 1056 "description": "Optional. Set this to True if this is the la
st log entry in the operation.", |
| 1057 "type": "boolean" |
| 1058 }, |
| 1059 "first": { |
| 1060 "description": "Optional. Set this to True if this is the fi
rst log entry in the operation.", |
| 1061 "type": "boolean" |
| 1062 }, |
| 1063 "id": { |
| 1064 "description": "Optional. An arbitrary operation identifier.
Log entries with the\nsame identifier are assumed to be part of the same operat
ion.", |
| 1065 "type": "string" |
| 1066 } |
| 1067 }, |
| 1068 "type": "object" |
| 1069 }, |
| 1070 "Empty": { |
| 1071 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 1072 "id": "Empty", |
| 1073 "properties": {}, |
| 1074 "type": "object" |
| 1075 }, |
| 1076 "HttpRequest": { |
| 1077 "description": "A common proto for logging HTTP requests. Only conta
ins semantics\ndefined by the HTTP specification. Product-specific logging\ninfo
rmation MUST be defined in a separate message.", |
| 1078 "id": "HttpRequest", |
| 1079 "properties": { |
| 1080 "cacheLookup": { |
| 1081 "description": "Whether or not a cache lookup was attempted.
", |
| 1082 "type": "boolean" |
| 1083 }, |
| 1084 "responseSize": { |
| 1085 "description": "The size of the HTTP response message sent b
ack to the client, in bytes,\nincluding the response headers and the response bo
dy.", |
| 1086 "format": "int64", |
| 1087 "type": "string" |
| 1088 }, |
| 1089 "status": { |
| 1090 "description": "The response code indicating the status of r
esponse.\nExamples: 200, 404.", |
| 1091 "format": "int32", |
| 1092 "type": "integer" |
| 1093 }, |
| 1094 "cacheValidatedWithOriginServer": { |
| 1095 "description": "Whether or not the response was validated wi
th the origin server before\nbeing served from cache. This field is only meaning
ful if `cache_hit` is\nTrue.", |
| 1096 "type": "boolean" |
| 1097 }, |
| 1098 "referer": { |
| 1099 "description": "The referer URL of the request, as defined i
n\n[HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc26
16-sec14.html).", |
| 1100 "type": "string" |
| 1101 }, |
| 1102 "cacheHit": { |
| 1103 "description": "Whether or not an entity was served from cac
he\n(with or without validation).", |
| 1104 "type": "boolean" |
| 1105 }, |
| 1106 "requestUrl": { |
| 1107 "description": "The scheme (http, https), the host name, the
path and the query\nportion of the URL that was requested.\nExample: `\"http://
example.com/some/info?color=red\"`.", |
| 1108 "type": "string" |
| 1109 }, |
| 1110 "latency": { |
| 1111 "description": "The request processing latency on the server
, from the time the request was\nreceived until the response was sent.", |
| 1112 "format": "google-duration", |
| 1113 "type": "string" |
| 1114 }, |
| 1115 "cacheFillBytes": { |
| 1116 "description": "The number of HTTP response bytes inserted i
nto cache. Set only when a\ncache fill was attempted.", |
| 1117 "format": "int64", |
| 1118 "type": "string" |
| 1119 }, |
| 1120 "requestMethod": { |
| 1121 "description": "The request method. Examples: `\"GET\"`, `\"
HEAD\"`, `\"PUT\"`, `\"POST\"`.", |
| 1122 "type": "string" |
| 1123 }, |
| 1124 "remoteIp": { |
| 1125 "description": "The IP address (IPv4 or IPv6) of the client
that issued the HTTP\nrequest. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:F
E1E:8329\"`.", |
| 1126 "type": "string" |
| 1127 }, |
| 1128 "serverIp": { |
| 1129 "description": "The IP address (IPv4 or IPv6) of the origin
server that the request was\nsent to.", |
| 1130 "type": "string" |
| 1131 }, |
| 1132 "userAgent": { |
| 1133 "description": "The user agent sent by the client. Example:\
n`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"
`.", |
| 1134 "type": "string" |
| 1135 }, |
| 1136 "requestSize": { |
| 1137 "description": "The size of the HTTP request message in byte
s, including the request\nheaders and the request body.", |
| 1138 "format": "int64", |
984 "type": "string" | 1139 "type": "string" |
985 } | 1140 } |
986 }, | 1141 }, |
987 "type": "object" | 1142 "type": "object" |
988 }, | 1143 }, |
989 "RequestLog": { | 1144 "RequestLog": { |
990 "description": "Complete log information about a single HTTP request
to an App Engine application.", | 1145 "description": "Complete log information about a single HTTP request
to an App Engine\napplication.", |
991 "id": "RequestLog", | 1146 "id": "RequestLog", |
992 "properties": { | 1147 "properties": { |
993 "appId": { | 1148 "responseSize": { |
994 "description": "Application that handled this request.", | 1149 "description": "Size in bytes sent back to client by request
.", |
995 "type": "string" | 1150 "format": "int64", |
996 }, | 1151 "type": "string" |
997 "moduleId": { | 1152 }, |
998 "description": "Module of the application that handled this
request.", | 1153 "requestId": { |
| 1154 "description": "Globally unique identifier for a request, wh
ich is based on the request\nstart time. Request IDs for requests which started
later will compare\ngreater as strings than those for requests which started ea
rlier.", |
| 1155 "type": "string" |
| 1156 }, |
| 1157 "first": { |
| 1158 "description": "Whether this is the first RequestLog entry f
or this request. If an active\nrequest has several RequestLog entries written t
o Cloud Logging, this field\nwill be set for one of them.", |
| 1159 "type": "boolean" |
| 1160 }, |
| 1161 "method": { |
| 1162 "description": "Request method. Example: `\"GET\"`, `\"HEAD\
"`, `\"PUT\"`, `\"POST\"`, `\"DELETE\"`.", |
999 "type": "string" | 1163 "type": "string" |
1000 }, | 1164 }, |
1001 "versionId": { | 1165 "versionId": { |
1002 "description": "Version of the application that handled this
request.", | 1166 "description": "Version of the application that handled this
request.", |
1003 "type": "string" | 1167 "type": "string" |
1004 }, | 1168 }, |
1005 "requestId": { | |
1006 "description": "Globally unique identifier for a request, wh
ich is based on the request start time. Request IDs for requests which started l
ater will compare greater as strings than those for requests which started earli
er.", | |
1007 "type": "string" | |
1008 }, | |
1009 "ip": { | |
1010 "description": "Origin IP address.", | |
1011 "type": "string" | |
1012 }, | |
1013 "startTime": { | |
1014 "description": "Time when the request started.", | |
1015 "type": "string" | |
1016 }, | |
1017 "endTime": { | |
1018 "description": "Time when the request finished.", | |
1019 "type": "string" | |
1020 }, | |
1021 "latency": { | |
1022 "description": "Latency of the request.", | |
1023 "type": "string" | |
1024 }, | |
1025 "megaCycles": { | |
1026 "description": "Number of CPU megacycles used to process req
uest.", | |
1027 "format": "int64", | |
1028 "type": "string" | |
1029 }, | |
1030 "method": { | |
1031 "description": "Request method. Example: `\"GET\"`, `\"HEAD\
"`, `\"PUT\"`, `\"POST\"`, `\"DELETE\"`.", | |
1032 "type": "string" | |
1033 }, | |
1034 "resource": { | |
1035 "description": "Contains the path and query portion of the U
RL that was requested. For example, if the URL was \"http://example.com/app?name
=val\", the resource would be \"/app?name=val\". The fragment identifier, which
is identified by the `#` character, is not included.", | |
1036 "type": "string" | |
1037 }, | |
1038 "httpVersion": { | |
1039 "description": "HTTP version of request. Example: `\"HTTP/1.
1\"`.", | |
1040 "type": "string" | |
1041 }, | |
1042 "status": { | 1169 "status": { |
1043 "description": "HTTP response status code. Example: 200, 404
.", | 1170 "description": "HTTP response status code. Example: 200, 404
.", |
1044 "format": "int32", | 1171 "format": "int32", |
1045 "type": "integer" | 1172 "type": "integer" |
1046 }, | 1173 }, |
1047 "responseSize": { | 1174 "wasLoadingRequest": { |
1048 "description": "Size in bytes sent back to client by request
.", | 1175 "description": "Whether this was a loading request for the i
nstance.", |
1049 "format": "int64", | 1176 "type": "boolean" |
1050 "type": "string" | |
1051 }, | 1177 }, |
1052 "referrer": { | 1178 "ip": { |
1053 "description": "Referrer URL of request.", | 1179 "description": "Origin IP address.", |
1054 "type": "string" | |
1055 }, | |
1056 "userAgent": { | |
1057 "description": "User agent that made the request.", | |
1058 "type": "string" | 1180 "type": "string" |
1059 }, | 1181 }, |
1060 "nickname": { | 1182 "nickname": { |
1061 "description": "The logged-in user who made the request. Mos
t likely, this is the part of the user's email before the `@` sign. The field va
lue is the same for different requests from the same user, but different users c
an have similar names. This information is also available to the application via
the App Engine Users API. This field will be populated starting with App Engine
1.9.21.", | 1183 "description": "The logged-in user who made the request.\n\n
Most likely, this is the part of the user's email before the `@` sign. The\nfie
ld value is the same for different requests from the same user, but\ndifferent u
sers can have similar names. This information is also\navailable to the applica
tion via the App Engine Users API.\n\nThis field will be populated starting with
App Engine 1.9.21.", |
| 1184 "type": "string" |
| 1185 }, |
| 1186 "taskQueueName": { |
| 1187 "description": "Queue name of the request, in the case of an
offline request.", |
| 1188 "type": "string" |
| 1189 }, |
| 1190 "pendingTime": { |
| 1191 "description": "Time this request spent in the pending reque
st queue.", |
| 1192 "format": "google-duration", |
| 1193 "type": "string" |
| 1194 }, |
| 1195 "instanceIndex": { |
| 1196 "description": "If the instance processing this request belo
ngs to a manually scaled\nmodule, then this is the 0-based index of the instance
. Otherwise, this\nvalue is -1.", |
| 1197 "format": "int32", |
| 1198 "type": "integer" |
| 1199 }, |
| 1200 "sourceReference": { |
| 1201 "description": "Source code for the application that handled
this request. There can be\nmore than one source reference per deployed applica
tion if source code is\ndistributed among multiple repositories.", |
| 1202 "items": { |
| 1203 "$ref": "SourceReference" |
| 1204 }, |
| 1205 "type": "array" |
| 1206 }, |
| 1207 "moduleId": { |
| 1208 "description": "Module of the application that handled this
request.", |
| 1209 "type": "string" |
| 1210 }, |
| 1211 "host": { |
| 1212 "description": "Internet host and port number of the resourc
e being requested.", |
| 1213 "type": "string" |
| 1214 }, |
| 1215 "latency": { |
| 1216 "description": "Latency of the request.", |
| 1217 "format": "google-duration", |
1062 "type": "string" | 1218 "type": "string" |
1063 }, | 1219 }, |
1064 "urlMapEntry": { | 1220 "urlMapEntry": { |
1065 "description": "File or class that handled the request.", | 1221 "description": "File or class that handled the request.", |
1066 "type": "string" | 1222 "type": "string" |
1067 }, | 1223 }, |
1068 "host": { | 1224 "endTime": { |
1069 "description": "Internet host and port number of the resourc
e being requested.", | 1225 "description": "Time when the request finished.", |
1070 "type": "string" | 1226 "format": "google-datetime", |
1071 }, | |
1072 "cost": { | |
1073 "description": "An indication of the relative cost of servin
g this request.", | |
1074 "format": "double", | |
1075 "type": "number" | |
1076 }, | |
1077 "taskQueueName": { | |
1078 "description": "Queue name of the request, in the case of an
offline request.", | |
1079 "type": "string" | |
1080 }, | |
1081 "taskName": { | |
1082 "description": "Task name of the request, in the case of an
offline request.", | |
1083 "type": "string" | |
1084 }, | |
1085 "wasLoadingRequest": { | |
1086 "description": "Whether this was a loading request for the i
nstance.", | |
1087 "type": "boolean" | |
1088 }, | |
1089 "pendingTime": { | |
1090 "description": "Time this request spent in the pending reque
st queue.", | |
1091 "type": "string" | |
1092 }, | |
1093 "instanceIndex": { | |
1094 "description": "If the instance processing this request belo
ngs to a manually scaled module, then this is the 0-based index of the instance.
Otherwise, this value is -1.", | |
1095 "format": "int32", | |
1096 "type": "integer" | |
1097 }, | |
1098 "finished": { | |
1099 "description": "Whether this request is finished or active."
, | |
1100 "type": "boolean" | |
1101 }, | |
1102 "first": { | |
1103 "description": "Whether this is the first RequestLog entry f
or this request. If an active request has several RequestLog entries written to
Cloud Logging, this field will be set for one of them.", | |
1104 "type": "boolean" | |
1105 }, | |
1106 "instanceId": { | |
1107 "description": "An identifier for the instance that handled
the request.", | |
1108 "type": "string" | 1227 "type": "string" |
1109 }, | 1228 }, |
1110 "line": { | 1229 "line": { |
1111 "description": "A list of log lines emitted by the applicati
on while serving this request.", | 1230 "description": "A list of log lines emitted by the applicati
on while serving this request.", |
1112 "items": { | 1231 "items": { |
1113 "$ref": "LogLine" | 1232 "$ref": "LogLine" |
1114 }, | 1233 }, |
1115 "type": "array" | 1234 "type": "array" |
1116 }, | 1235 }, |
1117 "appEngineRelease": { | 1236 "megaCycles": { |
1118 "description": "App Engine release version.", | 1237 "description": "Number of CPU megacycles used to process req
uest.", |
| 1238 "format": "int64", |
| 1239 "type": "string" |
| 1240 }, |
| 1241 "appId": { |
| 1242 "description": "Application that handled this request.", |
1119 "type": "string" | 1243 "type": "string" |
1120 }, | 1244 }, |
1121 "traceId": { | 1245 "traceId": { |
1122 "description": "Cloud Trace identifier for this request.", | 1246 "description": "Cloud Trace identifier for this request.", |
1123 "type": "string" | 1247 "type": "string" |
1124 }, | 1248 }, |
1125 "sourceReference": { | 1249 "taskName": { |
1126 "description": "Source code for the application that handled
this request. There can be more than one source reference per deployed applicat
ion if source code is distributed among multiple repositories.", | 1250 "description": "Task name of the request, in the case of an
offline request.", |
1127 "items": { | 1251 "type": "string" |
1128 "$ref": "SourceReference" | 1252 }, |
1129 }, | 1253 "cost": { |
1130 "type": "array" | 1254 "description": "An indication of the relative cost of servin
g this request.", |
| 1255 "format": "double", |
| 1256 "type": "number" |
| 1257 }, |
| 1258 "instanceId": { |
| 1259 "description": "An identifier for the instance that handled
the request.", |
| 1260 "type": "string" |
| 1261 }, |
| 1262 "startTime": { |
| 1263 "description": "Time when the request started.", |
| 1264 "format": "google-datetime", |
| 1265 "type": "string" |
| 1266 }, |
| 1267 "appEngineRelease": { |
| 1268 "description": "App Engine release version.", |
| 1269 "type": "string" |
| 1270 }, |
| 1271 "resource": { |
| 1272 "description": "Contains the path and query portion of the U
RL that was requested. For\nexample, if the URL was \"http://example.com/app?nam
e=val\", the resource\nwould be \"/app?name=val\". The fragment identifier, whi
ch is identified by\nthe `#` character, is not included.", |
| 1273 "type": "string" |
| 1274 }, |
| 1275 "httpVersion": { |
| 1276 "description": "HTTP version of request. Example: `\"HTTP/1.
1\"`.", |
| 1277 "type": "string" |
| 1278 }, |
| 1279 "referrer": { |
| 1280 "description": "Referrer URL of request.", |
| 1281 "type": "string" |
| 1282 }, |
| 1283 "userAgent": { |
| 1284 "description": "User agent that made the request.", |
| 1285 "type": "string" |
| 1286 }, |
| 1287 "finished": { |
| 1288 "description": "Whether this request is finished or active."
, |
| 1289 "type": "boolean" |
1131 } | 1290 } |
1132 }, | 1291 }, |
1133 "type": "object" | 1292 "type": "object" |
1134 }, | 1293 }, |
1135 "LogLine": { | 1294 "WriteLogEntriesResponse": { |
1136 "description": "Application log line emitted while processing a requ
est.", | 1295 "description": "Result returned from WriteLogEntries.\nempty", |
1137 "id": "LogLine", | 1296 "id": "WriteLogEntriesResponse", |
| 1297 "properties": {}, |
| 1298 "type": "object" |
| 1299 }, |
| 1300 "ListLogEntriesRequest": { |
| 1301 "description": "The parameters to `ListLogEntries`.", |
| 1302 "id": "ListLogEntriesRequest", |
1138 "properties": { | 1303 "properties": { |
1139 "time": { | 1304 "filter": { |
1140 "description": "Approximate time when this log entry was mad
e.", | 1305 "description": "Optional. A filter that chooses which log en
tries to return. See [Advanced\nLogs Filters](/logging/docs/view/advanced_filte
rs). Only log entries that\nmatch the filter are returned. An empty filter mat
ches all log entries.", |
1141 "type": "string" | 1306 "type": "string" |
1142 }, | 1307 }, |
1143 "severity": { | 1308 "projectIds": { |
1144 "description": "Severity of this log entry.", | 1309 "description": "Deprecated. One or more project identifiers
or project numbers from which\nto retrieve log entries. Examples: `\"my-project
-1A\"`, `\"1234567890\"`. If\npresent, these project identifiers are converted t
o resource format and\nadded to the list of resources in `resourceNames`. Caller
s should use\n`resourceNames` rather than this parameter.", |
1145 "enum": [ | 1310 "items": { |
1146 "DEFAULT", | 1311 "type": "string" |
1147 "DEBUG", | 1312 }, |
1148 "INFO", | 1313 "type": "array" |
1149 "NOTICE", | 1314 }, |
1150 "WARNING", | 1315 "resourceNames": { |
1151 "ERROR", | 1316 "description": "Required. One or more cloud resources from w
hich to retrieve log entries.\nExample: `\"projects/my-project-1A\"`, `\"project
s/1234567890\"`. Projects\nlisted in `projectIds` are added to this list.", |
1152 "CRITICAL", | 1317 "items": { |
1153 "ALERT", | 1318 "type": "string" |
1154 "EMERGENCY" | 1319 }, |
1155 ], | 1320 "type": "array" |
| 1321 }, |
| 1322 "pageSize": { |
| 1323 "description": "Optional. The maximum number of results to r
eturn from this request.\nNon-positive values are ignored. The presence of `nex
tPageToken` in the\nresponse indicates that more results might be available.", |
| 1324 "format": "int32", |
| 1325 "type": "integer" |
| 1326 }, |
| 1327 "orderBy": { |
| 1328 "description": "Optional. How the results should be sorted.
Presently, the only permitted\nvalues are `\"timestamp asc\"` (default) and `\"
timestamp desc\"`. The first\noption returns entries in order of increasing valu
es of\n`LogEntry.timestamp` (oldest first), and the second option returns entrie
s\nin order of decreasing timestamps (newest first). Entries with equal\ntimest
amps are returned in order of `LogEntry.insertId`.", |
1156 "type": "string" | 1329 "type": "string" |
1157 }, | 1330 }, |
1158 "logMessage": { | 1331 "pageToken": { |
1159 "description": "App-provided log message.", | 1332 "description": "Optional. If present, then retrieve the next
batch of results from the\npreceding call to this method. `pageToken` must be
the value of\n`nextPageToken` from the previous response. The values of other m
ethod\nparameters should be identical to those in the previous call.", |
1160 "type": "string" | |
1161 }, | |
1162 "sourceLocation": { | |
1163 "$ref": "SourceLocation", | |
1164 "description": "Where in the source code this log message wa
s written." | |
1165 } | |
1166 }, | |
1167 "type": "object" | |
1168 }, | |
1169 "SourceLocation": { | |
1170 "description": "Specifies a location in a source code file.", | |
1171 "id": "SourceLocation", | |
1172 "properties": { | |
1173 "file": { | |
1174 "description": "Source file name. Depending on the runtime e
nvironment, this might be a simple name or a fully-qualified name.", | |
1175 "type": "string" | |
1176 }, | |
1177 "line": { | |
1178 "description": "Line within the source file.", | |
1179 "format": "int64", | |
1180 "type": "string" | |
1181 }, | |
1182 "functionName": { | |
1183 "description": "Human-readable name of the function or metho
d being invoked, with optional context such as the class or package name. This i
nformation is used in contexts such as the logs viewer, where a file and line nu
mber are less meaningful. The format can vary by language. For example: `qual.if
.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).", | |
1184 "type": "string" | 1333 "type": "string" |
1185 } | 1334 } |
1186 }, | 1335 }, |
1187 "type": "object" | |
1188 }, | |
1189 "SourceReference": { | |
1190 "description": "A reference to a particular snapshot of the source t
ree used to build and deploy an application.", | |
1191 "id": "SourceReference", | |
1192 "properties": { | |
1193 "repository": { | |
1194 "description": "Optional. A URI string identifying the repos
itory. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", | |
1195 "type": "string" | |
1196 }, | |
1197 "revisionId": { | |
1198 "description": "The canonical and persistent identifier of t
he deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\
"", | |
1199 "type": "string" | |
1200 } | |
1201 }, | |
1202 "type": "object" | 1336 "type": "object" |
1203 } | 1337 } |
1204 }, | 1338 }, |
1205 "servicePath": "", | 1339 "servicePath": "", |
1206 "title": "Google Cloud Logging API", | 1340 "title": "Stackdriver Logging API", |
1207 "version": "v2beta1" | 1341 "version": "v2beta1" |
1208 } | 1342 } |
OLD | NEW |