Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(338)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/logging__v2.json

Issue 2571553005: Api-roll 43: 2016-12-13 (Closed)
Patch Set: Created 4 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/licensing__v1.json ('k') | discovery/googleapis/mirror__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 },
(...skipping 108 matching lines...) Expand 10 before | Expand all | Expand 10 after
119 "type": "string" 119 "type": "string"
120 }, 120 },
121 "upload_protocol": { 121 "upload_protocol": {
122 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 122 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
123 "location": "query", 123 "location": "query",
124 "type": "string" 124 "type": "string"
125 } 125 }
126 }, 126 },
127 "protocol": "rest", 127 "protocol": "rest",
128 "resources": { 128 "resources": {
129 "projects": { 129 "folders": {
130 "resources": { 130 "resources": {
131 "metrics": { 131 "logs": {
132 "methods": { 132 "methods": {
133 "update": { 133 "list": {
134 "description": "Creates or updates a logs-based metr ic.", 134 "description": "Lists the logs in projects or organi zations. Only logs that have entries are listed.",
135 "httpMethod": "PUT", 135 "httpMethod": "GET",
136 "id": "logging.projects.metrics.update", 136 "id": "logging.folders.logs.list",
137 "parameterOrder": [ 137 "parameterOrder": [
138 "metricName" 138 "parent"
139 ], 139 ],
140 "parameters": { 140 "parameters": {
141 "metricName": { 141 "pageSize": {
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. ", 142 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
143 "format": "int32",
144 "location": "query",
145 "type": "integer"
146 },
147 "parent": {
148 "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID ]\"\n",
143 "location": "path", 149 "location": "path",
144 "pattern": "^projects/[^/]+/metrics/[^/]+$", 150 "pattern": "^folders/[^/]+$",
151 "required": true,
152 "type": "string"
153 },
154 "pageToken": {
155 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
156 "location": "query",
157 "type": "string"
158 }
159 },
160 "path": "v2/{+parent}/logs",
161 "response": {
162 "$ref": "ListLogsResponse"
163 },
164 "scopes": [
165 "https://www.googleapis.com/auth/cloud-platform" ,
166 "https://www.googleapis.com/auth/cloud-platform. read-only",
167 "https://www.googleapis.com/auth/logging.admin",
168 "https://www.googleapis.com/auth/logging.read"
169 ]
170 },
171 "delete": {
172 "description": "Deletes all the log entries in a log . The log reappears if it receives new entries.",
173 "httpMethod": "DELETE",
174 "id": "logging.folders.logs.delete",
175 "parameterOrder": [
176 "logName"
177 ],
178 "parameters": {
179 "logName": {
180 "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/ [ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \" projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresou rcemanager.googleapis.com%2Factivity\". For more information about log names, se e LogEntry.",
181 "location": "path",
182 "pattern": "^folders/[^/]+/logs/[^/]+$",
145 "required": true, 183 "required": true,
146 "type": "string" 184 "type": "string"
147 } 185 }
148 }, 186 },
149 "path": "v2/{+metricName}", 187 "path": "v2/{+logName}",
150 "request": {
151 "$ref": "LogMetric"
152 },
153 "response": { 188 "response": {
154 "$ref": "LogMetric" 189 "$ref": "Empty"
155 }, 190 },
156 "scopes": [ 191 "scopes": [
157 "https://www.googleapis.com/auth/cloud-platform" , 192 "https://www.googleapis.com/auth/cloud-platform" ,
158 "https://www.googleapis.com/auth/logging.admin", 193 "https://www.googleapis.com/auth/logging.admin"
159 "https://www.googleapis.com/auth/logging.write" 194 ]
195 }
196 }
197 },
198 "sinks": {
199 "methods": {
200 "update": {
201 "description": "Updates a sink. If the named sink do esn't exist, then this method is identical to sinks.create. If the named sink do es exist, then this method replaces the following fields in the existing sink wi th values from the new sink: destination, filter, output_version_format, start_t ime, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
202 "httpMethod": "PUT",
203 "id": "logging.folders.sinks.update",
204 "parameterOrder": [
205 "sinkName"
206 ],
207 "parameters": {
208 "sinkName": {
209 "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
210 "location": "path",
211 "pattern": "^folders/[^/]+/sinks/[^/]+$",
212 "required": true,
213 "type": "string"
214 },
215 "uniqueWriterIdentity": {
216 "description": "Optional. See sinks.create f or a description of this field. When updating a sink, the effect of this field o n the value of writer_identity in the updated sink depends on both the old and n ew values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the ol d value was false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value was true and the new value is false.",
217 "location": "query",
218 "type": "boolean"
219 }
220 },
221 "path": "v2/{+sinkName}",
222 "request": {
223 "$ref": "LogSink"
224 },
225 "response": {
226 "$ref": "LogSink"
227 },
228 "scopes": [
229 "https://www.googleapis.com/auth/cloud-platform" ,
230 "https://www.googleapis.com/auth/logging.admin"
160 ] 231 ]
161 }, 232 },
162 "get": { 233 "get": {
163 "description": "Gets a logs-based metric.", 234 "description": "Gets a sink.",
164 "httpMethod": "GET", 235 "httpMethod": "GET",
165 "id": "logging.projects.metrics.get", 236 "id": "logging.folders.sinks.get",
166 "parameterOrder": [ 237 "parameterOrder": [
167 "metricName" 238 "sinkName"
168 ], 239 ],
169 "parameters": { 240 "parameters": {
170 "metricName": { 241 "sinkName": {
171 "description": "The resource name of the des ired metric.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.", 242 "description": "Required. The parent resourc e name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/ [ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my- sink-id\".",
172 "location": "path", 243 "location": "path",
173 "pattern": "^projects/[^/]+/metrics/[^/]+$", 244 "pattern": "^folders/[^/]+/sinks/[^/]+$",
174 "required": true, 245 "required": true,
175 "type": "string" 246 "type": "string"
176 } 247 }
177 }, 248 },
178 "path": "v2/{+metricName}", 249 "path": "v2/{+sinkName}",
179 "response": { 250 "response": {
180 "$ref": "LogMetric" 251 "$ref": "LogSink"
181 }, 252 },
182 "scopes": [ 253 "scopes": [
183 "https://www.googleapis.com/auth/cloud-platform" , 254 "https://www.googleapis.com/auth/cloud-platform" ,
184 "https://www.googleapis.com/auth/cloud-platform. read-only", 255 "https://www.googleapis.com/auth/cloud-platform. read-only",
185 "https://www.googleapis.com/auth/logging.admin", 256 "https://www.googleapis.com/auth/logging.admin",
186 "https://www.googleapis.com/auth/logging.read" 257 "https://www.googleapis.com/auth/logging.read"
187 ] 258 ]
188 }, 259 },
189 "create": { 260 "create": {
190 "description": "Creates a logs-based metric.", 261 "description": "Creates a sink that exports specifie d log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times o r the sink's writer_identity is not permitted to write to the destination. A sin k can export log entries only from the resource owning the sink.",
191 "httpMethod": "POST", 262 "httpMethod": "POST",
192 "id": "logging.projects.metrics.create", 263 "id": "logging.folders.sinks.create",
193 "parameterOrder": [ 264 "parameterOrder": [
194 "parent" 265 "parent"
195 ], 266 ],
196 "parameters": { 267 "parameters": {
268 "uniqueWriterIdentity": {
269 "description": "Optional. Determines the kin d of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value r eturned as writer_identity is cloud-logs@google.com, the same identity used befo re the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from t he new sink. For more information, see writer_identity in LogSink.",
270 "location": "query",
271 "type": "boolean"
272 },
197 "parent": { 273 "parent": {
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.", 274 "description": "Required. The resource in wh ich to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATIO N_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\". ",
199 "location": "path", 275 "location": "path",
200 "pattern": "^projects/[^/]+$", 276 "pattern": "^folders/[^/]+$",
201 "required": true, 277 "required": true,
202 "type": "string" 278 "type": "string"
203 } 279 }
204 }, 280 },
205 "path": "v2/{+parent}/metrics", 281 "path": "v2/{+parent}/sinks",
206 "request": { 282 "request": {
207 "$ref": "LogMetric" 283 "$ref": "LogSink"
208 }, 284 },
209 "response": { 285 "response": {
210 "$ref": "LogMetric" 286 "$ref": "LogSink"
211 }, 287 },
212 "scopes": [ 288 "scopes": [
213 "https://www.googleapis.com/auth/cloud-platform" , 289 "https://www.googleapis.com/auth/cloud-platform" ,
214 "https://www.googleapis.com/auth/logging.admin", 290 "https://www.googleapis.com/auth/logging.admin"
215 "https://www.googleapis.com/auth/logging.write"
216 ] 291 ]
217 }, 292 },
218 "list": { 293 "list": {
219 "description": "Lists logs-based metrics.", 294 "description": "Lists sinks.",
220 "httpMethod": "GET", 295 "httpMethod": "GET",
221 "id": "logging.projects.metrics.list", 296 "id": "logging.folders.sinks.list",
222 "parameterOrder": [ 297 "parameterOrder": [
223 "parent" 298 "parent"
224 ], 299 ],
225 "parameters": { 300 "parameters": {
226 "pageSize": { 301 "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.", 302 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
228 "format": "int32", 303 "format": "int32",
229 "location": "query", 304 "location": "query",
230 "type": "integer" 305 "type": "integer"
231 }, 306 },
232 "parent": { 307 "parent": {
233 "description": "Required. The resource name containing the metrics.\nExample: `\"projects/my-project-id\"`.", 308 "description": "Required. The parent resourc e whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"org anizations/123456789\".",
234 "location": "path", 309 "location": "path",
235 "pattern": "^projects/[^/]+$", 310 "pattern": "^folders/[^/]+$",
236 "required": true, 311 "required": true,
237 "type": "string" 312 "type": "string"
238 }, 313 },
239 "pageToken": { 314 "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.", 315 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
241 "location": "query", 316 "location": "query",
242 "type": "string" 317 "type": "string"
243 } 318 }
244 }, 319 },
245 "path": "v2/{+parent}/metrics", 320 "path": "v2/{+parent}/sinks",
246 "response": { 321 "response": {
247 "$ref": "ListLogMetricsResponse" 322 "$ref": "ListSinksResponse"
248 }, 323 },
249 "scopes": [ 324 "scopes": [
250 "https://www.googleapis.com/auth/cloud-platform" , 325 "https://www.googleapis.com/auth/cloud-platform" ,
251 "https://www.googleapis.com/auth/cloud-platform. read-only", 326 "https://www.googleapis.com/auth/cloud-platform. read-only",
252 "https://www.googleapis.com/auth/logging.admin", 327 "https://www.googleapis.com/auth/logging.admin",
253 "https://www.googleapis.com/auth/logging.read" 328 "https://www.googleapis.com/auth/logging.read"
254 ] 329 ]
255 }, 330 },
256 "delete": { 331 "delete": {
257 "description": "Deletes a logs-based metric.", 332 "description": "Deletes a sink. If the sink has a un ique writer_identity, then that service account is also deleted.",
258 "httpMethod": "DELETE", 333 "httpMethod": "DELETE",
259 "id": "logging.projects.metrics.delete", 334 "id": "logging.folders.sinks.delete",
260 "parameterOrder": [ 335 "parameterOrder": [
261 "metricName" 336 "sinkName"
262 ], 337 ],
263 "parameters": { 338 "parameters": {
264 "metricName": { 339 "sinkName": {
265 "description": "The resource name of the met ric to delete.\nExample: `\"projects/my-project-id/metrics/my-metric-id\"`.", 340 "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nIt is an error if the sink does not exist. Example: \"projec ts/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist." ,
266 "location": "path", 341 "location": "path",
267 "pattern": "^projects/[^/]+/metrics/[^/]+$", 342 "pattern": "^folders/[^/]+/sinks/[^/]+$",
268 "required": true, 343 "required": true,
269 "type": "string" 344 "type": "string"
270 } 345 }
271 }, 346 },
272 "path": "v2/{+metricName}", 347 "path": "v2/{+sinkName}",
273 "response": { 348 "response": {
274 "$ref": "Empty" 349 "$ref": "Empty"
275 }, 350 },
276 "scopes": [ 351 "scopes": [
277 "https://www.googleapis.com/auth/cloud-platform" , 352 "https://www.googleapis.com/auth/cloud-platform" ,
278 "https://www.googleapis.com/auth/logging.admin", 353 "https://www.googleapis.com/auth/logging.admin"
279 "https://www.googleapis.com/auth/logging.write"
280 ] 354 ]
281 } 355 }
282 } 356 }
283 }, 357 }
358 }
359 },
360 "billingAccounts": {
361 "resources": {
284 "logs": { 362 "logs": {
285 "methods": { 363 "methods": {
364 "list": {
365 "description": "Lists the logs in projects or organi zations. Only logs that have entries are listed.",
366 "httpMethod": "GET",
367 "id": "logging.billingAccounts.logs.list",
368 "parameterOrder": [
369 "parent"
370 ],
371 "parameters": {
372 "pageSize": {
373 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
374 "format": "int32",
375 "location": "query",
376 "type": "integer"
377 },
378 "parent": {
379 "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID ]\"\n",
380 "location": "path",
381 "pattern": "^billingAccounts/[^/]+$",
382 "required": true,
383 "type": "string"
384 },
385 "pageToken": {
386 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
387 "location": "query",
388 "type": "string"
389 }
390 },
391 "path": "v2/{+parent}/logs",
392 "response": {
393 "$ref": "ListLogsResponse"
394 },
395 "scopes": [
396 "https://www.googleapis.com/auth/cloud-platform" ,
397 "https://www.googleapis.com/auth/cloud-platform. read-only",
398 "https://www.googleapis.com/auth/logging.admin",
399 "https://www.googleapis.com/auth/logging.read"
400 ]
401 },
286 "delete": { 402 "delete": {
287 "description": "Deletes a log and all its log entrie s.\nThe log will reappear if it receives new entries.", 403 "description": "Deletes all the log entries in a log . The log reappears if it receives new entries.",
288 "httpMethod": "DELETE", 404 "httpMethod": "DELETE",
289 "id": "logging.projects.logs.delete", 405 "id": "logging.billingAccounts.logs.delete",
290 "parameterOrder": [ 406 "parameterOrder": [
291 "logName" 407 "logName"
292 ], 408 ],
293 "parameters": { 409 "parameters": {
294 "logName": { 410 "logName": {
295 "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.", 411 "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/ [ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \" projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresou rcemanager.googleapis.com%2Factivity\". For more information about log names, se e LogEntry.",
296 "location": "path", 412 "location": "path",
297 "pattern": "^projects/[^/]+/logs/[^/]+$", 413 "pattern": "^billingAccounts/[^/]+/logs/[^/] +$",
298 "required": true, 414 "required": true,
299 "type": "string" 415 "type": "string"
300 } 416 }
301 }, 417 },
302 "path": "v2/{+logName}", 418 "path": "v2/{+logName}",
303 "response": { 419 "response": {
304 "$ref": "Empty" 420 "$ref": "Empty"
305 }, 421 },
306 "scopes": [ 422 "scopes": [
307 "https://www.googleapis.com/auth/cloud-platform" , 423 "https://www.googleapis.com/auth/cloud-platform" ,
308 "https://www.googleapis.com/auth/logging.admin" 424 "https://www.googleapis.com/auth/logging.admin"
309 ] 425 ]
310 } 426 }
311 } 427 }
312 }, 428 },
313 "sinks": { 429 "sinks": {
314 "methods": { 430 "methods": {
315 "update": { 431 "update": {
316 "description": "Updates or creates a sink.", 432 "description": "Updates a sink. If the named sink do esn't exist, then this method is identical to sinks.create. If the named sink do es exist, then this method replaces the following fields in the existing sink wi th values from the new sink: destination, filter, output_version_format, start_t ime, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
317 "httpMethod": "PUT", 433 "httpMethod": "PUT",
318 "id": "logging.projects.sinks.update", 434 "id": "logging.billingAccounts.sinks.update",
319 "parameterOrder": [ 435 "parameterOrder": [
320 "sinkName" 436 "sinkName"
321 ], 437 ],
322 "parameters": { 438 "parameters": {
323 "sinkName": { 439 "sinkName": {
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\"`.", 440 "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
325 "location": "path", 441 "location": "path",
326 "pattern": "^projects/[^/]+/sinks/[^/]+$", 442 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
327 "required": true, 443 "required": true,
328 "type": "string" 444 "type": "string"
329 }, 445 },
330 "uniqueWriterIdentity": { 446 "uniqueWriterIdentity": {
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.", 447 "description": "Optional. See sinks.create f or a description of this field. When updating a sink, the effect of this field o n the value of writer_identity in the updated sink depends on both the old and n ew values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the ol d value was false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value was true and the new value is false.",
332 "location": "query", 448 "location": "query",
333 "type": "boolean" 449 "type": "boolean"
334 } 450 }
335 }, 451 },
336 "path": "v2/{+sinkName}", 452 "path": "v2/{+sinkName}",
337 "request": { 453 "request": {
338 "$ref": "LogSink" 454 "$ref": "LogSink"
339 }, 455 },
340 "response": { 456 "response": {
341 "$ref": "LogSink" 457 "$ref": "LogSink"
342 }, 458 },
343 "scopes": [ 459 "scopes": [
344 "https://www.googleapis.com/auth/cloud-platform" , 460 "https://www.googleapis.com/auth/cloud-platform" ,
345 "https://www.googleapis.com/auth/logging.admin" 461 "https://www.googleapis.com/auth/logging.admin"
346 ] 462 ]
347 }, 463 },
348 "get": { 464 "get": {
349 "description": "Gets a sink.", 465 "description": "Gets a sink.",
350 "httpMethod": "GET", 466 "httpMethod": "GET",
351 "id": "logging.projects.sinks.get", 467 "id": "logging.billingAccounts.sinks.get",
352 "parameterOrder": [ 468 "parameterOrder": [
353 "sinkName" 469 "sinkName"
354 ], 470 ],
355 "parameters": { 471 "parameters": {
356 "sinkName": { 472 "sinkName": {
357 "description": "Required. The resource name of the sink to return.\nExample: `\"projects/my-project-id/sinks/my-sink-id\"`." , 473 "description": "Required. The parent resourc e name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/ [ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my- sink-id\".",
358 "location": "path", 474 "location": "path",
359 "pattern": "^projects/[^/]+/sinks/[^/]+$", 475 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
360 "required": true, 476 "required": true,
361 "type": "string" 477 "type": "string"
362 } 478 }
363 }, 479 },
364 "path": "v2/{+sinkName}", 480 "path": "v2/{+sinkName}",
365 "response": { 481 "response": {
366 "$ref": "LogSink" 482 "$ref": "LogSink"
367 }, 483 },
368 "scopes": [ 484 "scopes": [
369 "https://www.googleapis.com/auth/cloud-platform" , 485 "https://www.googleapis.com/auth/cloud-platform" ,
370 "https://www.googleapis.com/auth/cloud-platform. read-only", 486 "https://www.googleapis.com/auth/cloud-platform. read-only",
371 "https://www.googleapis.com/auth/logging.admin", 487 "https://www.googleapis.com/auth/logging.admin",
372 "https://www.googleapis.com/auth/logging.read" 488 "https://www.googleapis.com/auth/logging.read"
373 ] 489 ]
374 }, 490 },
375 "create": { 491 "create": {
376 "description": "Creates a sink.", 492 "description": "Creates a sink that exports specifie d log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times o r the sink's writer_identity is not permitted to write to the destination. A sin k can export log entries only from the resource owning the sink.",
377 "httpMethod": "POST", 493 "httpMethod": "POST",
378 "id": "logging.projects.sinks.create", 494 "id": "logging.billingAccounts.sinks.create",
379 "parameterOrder": [ 495 "parameterOrder": [
380 "parent" 496 "parent"
381 ], 497 ],
382 "parameters": { 498 "parameters": {
383 "uniqueWriterIdentity": { 499 "uniqueWriterIdentity": {
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.", 500 "description": "Optional. Determines the kin d of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value r eturned as writer_identity is cloud-logs@google.com, the same identity used befo re the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from t he new sink. For more information, see writer_identity in LogSink.",
385 "location": "query", 501 "location": "query",
386 "type": "boolean" 502 "type": "boolean"
387 }, 503 },
388 "parent": { 504 "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.", 505 "description": "Required. The resource in wh ich to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATIO N_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\". ",
390 "location": "path", 506 "location": "path",
391 "pattern": "^projects/[^/]+$", 507 "pattern": "^billingAccounts/[^/]+$",
392 "required": true, 508 "required": true,
393 "type": "string" 509 "type": "string"
394 } 510 }
395 }, 511 },
396 "path": "v2/{+parent}/sinks", 512 "path": "v2/{+parent}/sinks",
397 "request": { 513 "request": {
398 "$ref": "LogSink" 514 "$ref": "LogSink"
399 }, 515 },
400 "response": { 516 "response": {
401 "$ref": "LogSink" 517 "$ref": "LogSink"
402 }, 518 },
403 "scopes": [ 519 "scopes": [
404 "https://www.googleapis.com/auth/cloud-platform" , 520 "https://www.googleapis.com/auth/cloud-platform" ,
405 "https://www.googleapis.com/auth/logging.admin" 521 "https://www.googleapis.com/auth/logging.admin"
406 ] 522 ]
407 }, 523 },
408 "list": { 524 "list": {
409 "description": "Lists sinks.", 525 "description": "Lists sinks.",
410 "httpMethod": "GET", 526 "httpMethod": "GET",
411 "id": "logging.projects.sinks.list", 527 "id": "logging.billingAccounts.sinks.list",
412 "parameterOrder": [ 528 "parameterOrder": [
413 "parent" 529 "parent"
414 ], 530 ],
415 "parameters": { 531 "parameters": {
416 "pageSize": { 532 "pageSize": {
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.", 533 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
418 "format": "int32", 534 "format": "int32",
419 "location": "query", 535 "location": "query",
420 "type": "integer" 536 "type": "integer"
421 }, 537 },
422 "parent": { 538 "parent": {
423 "description": "Required. The resource name where this sink was created.\nExample: `\"projects/my-logging-project\"`.", 539 "description": "Required. The parent resourc e whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"org anizations/123456789\".",
424 "location": "path", 540 "location": "path",
425 "pattern": "^projects/[^/]+$", 541 "pattern": "^billingAccounts/[^/]+$",
426 "required": true, 542 "required": true,
427 "type": "string" 543 "type": "string"
428 }, 544 },
429 "pageToken": { 545 "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.", 546 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
431 "location": "query", 547 "location": "query",
432 "type": "string" 548 "type": "string"
433 } 549 }
434 }, 550 },
435 "path": "v2/{+parent}/sinks", 551 "path": "v2/{+parent}/sinks",
436 "response": { 552 "response": {
437 "$ref": "ListSinksResponse" 553 "$ref": "ListSinksResponse"
438 }, 554 },
439 "scopes": [ 555 "scopes": [
440 "https://www.googleapis.com/auth/cloud-platform" , 556 "https://www.googleapis.com/auth/cloud-platform" ,
441 "https://www.googleapis.com/auth/cloud-platform. read-only", 557 "https://www.googleapis.com/auth/cloud-platform. read-only",
442 "https://www.googleapis.com/auth/logging.admin", 558 "https://www.googleapis.com/auth/logging.admin",
443 "https://www.googleapis.com/auth/logging.read" 559 "https://www.googleapis.com/auth/logging.read"
444 ] 560 ]
445 }, 561 },
446 "delete": { 562 "delete": {
447 "description": "Deletes a sink.", 563 "description": "Deletes a sink. If the sink has a un ique writer_identity, then that service account is also deleted.",
448 "httpMethod": "DELETE", 564 "httpMethod": "DELETE",
449 "id": "logging.projects.sinks.delete", 565 "id": "logging.billingAccounts.sinks.delete",
450 "parameterOrder": [ 566 "parameterOrder": [
451 "sinkName" 567 "sinkName"
452 ], 568 ],
453 "parameters": { 569 "parameters": {
454 "sinkName": { 570 "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.", 571 "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nIt is an error if the sink does not exist. Example: \"projec ts/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist." ,
456 "location": "path", 572 "location": "path",
457 "pattern": "^projects/[^/]+/sinks/[^/]+$", 573 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
458 "required": true, 574 "required": true,
459 "type": "string" 575 "type": "string"
460 } 576 }
461 }, 577 },
462 "path": "v2/{+sinkName}", 578 "path": "v2/{+sinkName}",
463 "response": { 579 "response": {
464 "$ref": "Empty" 580 "$ref": "Empty"
465 }, 581 },
466 "scopes": [ 582 "scopes": [
467 "https://www.googleapis.com/auth/cloud-platform" , 583 "https://www.googleapis.com/auth/cloud-platform" ,
468 "https://www.googleapis.com/auth/logging.admin" 584 "https://www.googleapis.com/auth/logging.admin"
469 ] 585 ]
470 } 586 }
471 } 587 }
472 } 588 }
473 } 589 }
474 }, 590 },
475 "organizations": { 591 "organizations": {
476 "resources": { 592 "resources": {
477 "logs": { 593 "logs": {
478 "methods": { 594 "methods": {
595 "list": {
596 "description": "Lists the logs in projects or organi zations. Only logs that have entries are listed.",
597 "httpMethod": "GET",
598 "id": "logging.organizations.logs.list",
599 "parameterOrder": [
600 "parent"
601 ],
602 "parameters": {
603 "pageSize": {
604 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
605 "format": "int32",
606 "location": "query",
607 "type": "integer"
608 },
609 "parent": {
610 "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID ]\"\n",
611 "location": "path",
612 "pattern": "^organizations/[^/]+$",
613 "required": true,
614 "type": "string"
615 },
616 "pageToken": {
617 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
618 "location": "query",
619 "type": "string"
620 }
621 },
622 "path": "v2/{+parent}/logs",
623 "response": {
624 "$ref": "ListLogsResponse"
625 },
626 "scopes": [
627 "https://www.googleapis.com/auth/cloud-platform" ,
628 "https://www.googleapis.com/auth/cloud-platform. read-only",
629 "https://www.googleapis.com/auth/logging.admin",
630 "https://www.googleapis.com/auth/logging.read"
631 ]
632 },
479 "delete": { 633 "delete": {
480 "description": "Deletes a log and all its log entrie s.\nThe log will reappear if it receives new entries.", 634 "description": "Deletes all the log entries in a log . The log reappears if it receives new entries.",
481 "httpMethod": "DELETE", 635 "httpMethod": "DELETE",
482 "id": "logging.organizations.logs.delete", 636 "id": "logging.organizations.logs.delete",
483 "parameterOrder": [ 637 "parameterOrder": [
484 "logName" 638 "logName"
485 ], 639 ],
486 "parameters": { 640 "parameters": {
487 "logName": { 641 "logName": {
488 "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.", 642 "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/ [ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \" projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresou rcemanager.googleapis.com%2Factivity\". For more information about log names, se e LogEntry.",
489 "location": "path", 643 "location": "path",
490 "pattern": "^organizations/[^/]+/logs/[^/]+$ ", 644 "pattern": "^organizations/[^/]+/logs/[^/]+$ ",
491 "required": true, 645 "required": true,
492 "type": "string" 646 "type": "string"
493 } 647 }
648 },
649 "path": "v2/{+logName}",
650 "response": {
651 "$ref": "Empty"
652 },
653 "scopes": [
654 "https://www.googleapis.com/auth/cloud-platform" ,
655 "https://www.googleapis.com/auth/logging.admin"
656 ]
657 }
658 }
659 },
660 "sinks": {
661 "methods": {
662 "update": {
663 "description": "Updates a sink. If the named sink do esn't exist, then this method is identical to sinks.create. If the named sink do es exist, then this method replaces the following fields in the existing sink wi th values from the new sink: destination, filter, output_version_format, start_t ime, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
664 "httpMethod": "PUT",
665 "id": "logging.organizations.sinks.update",
666 "parameterOrder": [
667 "sinkName"
668 ],
669 "parameters": {
670 "sinkName": {
671 "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
672 "location": "path",
673 "pattern": "^organizations/[^/]+/sinks/[^/]+ $",
674 "required": true,
675 "type": "string"
676 },
677 "uniqueWriterIdentity": {
678 "description": "Optional. See sinks.create f or a description of this field. When updating a sink, the effect of this field o n the value of writer_identity in the updated sink depends on both the old and n ew values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the ol d value was false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value was true and the new value is false.",
679 "location": "query",
680 "type": "boolean"
681 }
682 },
683 "path": "v2/{+sinkName}",
684 "request": {
685 "$ref": "LogSink"
686 },
687 "response": {
688 "$ref": "LogSink"
689 },
690 "scopes": [
691 "https://www.googleapis.com/auth/cloud-platform" ,
692 "https://www.googleapis.com/auth/logging.admin"
693 ]
694 },
695 "get": {
696 "description": "Gets a sink.",
697 "httpMethod": "GET",
698 "id": "logging.organizations.sinks.get",
699 "parameterOrder": [
700 "sinkName"
701 ],
702 "parameters": {
703 "sinkName": {
704 "description": "Required. The parent resourc e name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/ [ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my- sink-id\".",
705 "location": "path",
706 "pattern": "^organizations/[^/]+/sinks/[^/]+ $",
707 "required": true,
708 "type": "string"
709 }
710 },
711 "path": "v2/{+sinkName}",
712 "response": {
713 "$ref": "LogSink"
714 },
715 "scopes": [
716 "https://www.googleapis.com/auth/cloud-platform" ,
717 "https://www.googleapis.com/auth/cloud-platform. read-only",
718 "https://www.googleapis.com/auth/logging.admin",
719 "https://www.googleapis.com/auth/logging.read"
720 ]
721 },
722 "create": {
723 "description": "Creates a sink that exports specifie d log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times o r the sink's writer_identity is not permitted to write to the destination. A sin k can export log entries only from the resource owning the sink.",
724 "httpMethod": "POST",
725 "id": "logging.organizations.sinks.create",
726 "parameterOrder": [
727 "parent"
728 ],
729 "parameters": {
730 "uniqueWriterIdentity": {
731 "description": "Optional. Determines the kin d of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value r eturned as writer_identity is cloud-logs@google.com, the same identity used befo re the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from t he new sink. For more information, see writer_identity in LogSink.",
732 "location": "query",
733 "type": "boolean"
734 },
735 "parent": {
736 "description": "Required. The resource in wh ich to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATIO N_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\". ",
737 "location": "path",
738 "pattern": "^organizations/[^/]+$",
739 "required": true,
740 "type": "string"
741 }
742 },
743 "path": "v2/{+parent}/sinks",
744 "request": {
745 "$ref": "LogSink"
746 },
747 "response": {
748 "$ref": "LogSink"
749 },
750 "scopes": [
751 "https://www.googleapis.com/auth/cloud-platform" ,
752 "https://www.googleapis.com/auth/logging.admin"
753 ]
754 },
755 "list": {
756 "description": "Lists sinks.",
757 "httpMethod": "GET",
758 "id": "logging.organizations.sinks.list",
759 "parameterOrder": [
760 "parent"
761 ],
762 "parameters": {
763 "pageSize": {
764 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
765 "format": "int32",
766 "location": "query",
767 "type": "integer"
768 },
769 "parent": {
770 "description": "Required. The parent resourc e whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"org anizations/123456789\".",
771 "location": "path",
772 "pattern": "^organizations/[^/]+$",
773 "required": true,
774 "type": "string"
775 },
776 "pageToken": {
777 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
778 "location": "query",
779 "type": "string"
780 }
781 },
782 "path": "v2/{+parent}/sinks",
783 "response": {
784 "$ref": "ListSinksResponse"
785 },
786 "scopes": [
787 "https://www.googleapis.com/auth/cloud-platform" ,
788 "https://www.googleapis.com/auth/cloud-platform. read-only",
789 "https://www.googleapis.com/auth/logging.admin",
790 "https://www.googleapis.com/auth/logging.read"
791 ]
792 },
793 "delete": {
794 "description": "Deletes a sink. If the sink has a un ique writer_identity, then that service account is also deleted.",
795 "httpMethod": "DELETE",
796 "id": "logging.organizations.sinks.delete",
797 "parameterOrder": [
798 "sinkName"
799 ],
800 "parameters": {
801 "sinkName": {
802 "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nIt is an error if the sink does not exist. Example: \"projec ts/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist." ,
803 "location": "path",
804 "pattern": "^organizations/[^/]+/sinks/[^/]+ $",
805 "required": true,
806 "type": "string"
807 }
808 },
809 "path": "v2/{+sinkName}",
810 "response": {
811 "$ref": "Empty"
812 },
813 "scopes": [
814 "https://www.googleapis.com/auth/cloud-platform" ,
815 "https://www.googleapis.com/auth/logging.admin"
816 ]
817 }
818 }
819 }
820 }
821 },
822 "projects": {
823 "resources": {
824 "metrics": {
825 "methods": {
826 "update": {
827 "description": "Creates or updates a logs-based metr ic.",
828 "httpMethod": "PUT",
829 "id": "logging.projects.metrics.update",
830 "parameterOrder": [
831 "metricName"
832 ],
833 "parameters": {
834 "metricName": {
835 "description": "The resource name of the met ric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metri c must be provided in the request and it's name field must be the same as [METRI C_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created .",
836 "location": "path",
837 "pattern": "^projects/[^/]+/metrics/[^/]+$",
838 "required": true,
839 "type": "string"
840 }
841 },
842 "path": "v2/{+metricName}",
843 "request": {
844 "$ref": "LogMetric"
845 },
846 "response": {
847 "$ref": "LogMetric"
848 },
849 "scopes": [
850 "https://www.googleapis.com/auth/cloud-platform" ,
851 "https://www.googleapis.com/auth/logging.admin",
852 "https://www.googleapis.com/auth/logging.write"
853 ]
854 },
855 "get": {
856 "description": "Gets a logs-based metric.",
857 "httpMethod": "GET",
858 "id": "logging.projects.metrics.get",
859 "parameterOrder": [
860 "metricName"
861 ],
862 "parameters": {
863 "metricName": {
864 "description": "The resource name of the des ired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
865 "location": "path",
866 "pattern": "^projects/[^/]+/metrics/[^/]+$",
867 "required": true,
868 "type": "string"
869 }
870 },
871 "path": "v2/{+metricName}",
872 "response": {
873 "$ref": "LogMetric"
874 },
875 "scopes": [
876 "https://www.googleapis.com/auth/cloud-platform" ,
877 "https://www.googleapis.com/auth/cloud-platform. read-only",
878 "https://www.googleapis.com/auth/logging.admin",
879 "https://www.googleapis.com/auth/logging.read"
880 ]
881 },
882 "create": {
883 "description": "Creates a logs-based metric.",
884 "httpMethod": "POST",
885 "id": "logging.projects.metrics.create",
886 "parameterOrder": [
887 "parent"
888 ],
889 "parameters": {
890 "parent": {
891 "description": "The resource name of the pro ject in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric m ust be provided in the request.",
892 "location": "path",
893 "pattern": "^projects/[^/]+$",
894 "required": true,
895 "type": "string"
896 }
897 },
898 "path": "v2/{+parent}/metrics",
899 "request": {
900 "$ref": "LogMetric"
901 },
902 "response": {
903 "$ref": "LogMetric"
904 },
905 "scopes": [
906 "https://www.googleapis.com/auth/cloud-platform" ,
907 "https://www.googleapis.com/auth/logging.admin",
908 "https://www.googleapis.com/auth/logging.write"
909 ]
910 },
911 "list": {
912 "description": "Lists logs-based metrics.",
913 "httpMethod": "GET",
914 "id": "logging.projects.metrics.list",
915 "parameterOrder": [
916 "parent"
917 ],
918 "parameters": {
919 "pageSize": {
920 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
921 "format": "int32",
922 "location": "query",
923 "type": "integer"
924 },
925 "parent": {
926 "description": "Required. The name of the pr oject containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
927 "location": "path",
928 "pattern": "^projects/[^/]+$",
929 "required": true,
930 "type": "string"
931 },
932 "pageToken": {
933 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
934 "location": "query",
935 "type": "string"
936 }
937 },
938 "path": "v2/{+parent}/metrics",
939 "response": {
940 "$ref": "ListLogMetricsResponse"
941 },
942 "scopes": [
943 "https://www.googleapis.com/auth/cloud-platform" ,
944 "https://www.googleapis.com/auth/cloud-platform. read-only",
945 "https://www.googleapis.com/auth/logging.admin",
946 "https://www.googleapis.com/auth/logging.read"
947 ]
948 },
949 "delete": {
950 "description": "Deletes a logs-based metric.",
951 "httpMethod": "DELETE",
952 "id": "logging.projects.metrics.delete",
953 "parameterOrder": [
954 "metricName"
955 ],
956 "parameters": {
957 "metricName": {
958 "description": "The resource name of the met ric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
959 "location": "path",
960 "pattern": "^projects/[^/]+/metrics/[^/]+$",
961 "required": true,
962 "type": "string"
963 }
964 },
965 "path": "v2/{+metricName}",
966 "response": {
967 "$ref": "Empty"
968 },
969 "scopes": [
970 "https://www.googleapis.com/auth/cloud-platform" ,
971 "https://www.googleapis.com/auth/logging.admin",
972 "https://www.googleapis.com/auth/logging.write"
973 ]
974 }
975 }
976 },
977 "logs": {
978 "methods": {
979 "list": {
980 "description": "Lists the logs in projects or organi zations. Only logs that have entries are listed.",
981 "httpMethod": "GET",
982 "id": "logging.projects.logs.list",
983 "parameterOrder": [
984 "parent"
985 ],
986 "parameters": {
987 "pageSize": {
988 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
989 "format": "int32",
990 "location": "query",
991 "type": "integer"
992 },
993 "parent": {
994 "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID ]\"\n",
995 "location": "path",
996 "pattern": "^projects/[^/]+$",
997 "required": true,
998 "type": "string"
999 },
1000 "pageToken": {
1001 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
1002 "location": "query",
1003 "type": "string"
1004 }
1005 },
1006 "path": "v2/{+parent}/logs",
1007 "response": {
1008 "$ref": "ListLogsResponse"
1009 },
1010 "scopes": [
1011 "https://www.googleapis.com/auth/cloud-platform" ,
1012 "https://www.googleapis.com/auth/cloud-platform. read-only",
1013 "https://www.googleapis.com/auth/logging.admin",
1014 "https://www.googleapis.com/auth/logging.read"
1015 ]
1016 },
1017 "delete": {
1018 "description": "Deletes all the log entries in a log . The log reappears if it receives new entries.",
1019 "httpMethod": "DELETE",
1020 "id": "logging.projects.logs.delete",
1021 "parameterOrder": [
1022 "logName"
1023 ],
1024 "parameters": {
1025 "logName": {
1026 "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/ [ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \" projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresou rcemanager.googleapis.com%2Factivity\". For more information about log names, se e LogEntry.",
1027 "location": "path",
1028 "pattern": "^projects/[^/]+/logs/[^/]+$",
1029 "required": true,
1030 "type": "string"
1031 }
494 }, 1032 },
495 "path": "v2/{+logName}", 1033 "path": "v2/{+logName}",
496 "response": { 1034 "response": {
497 "$ref": "Empty" 1035 "$ref": "Empty"
498 }, 1036 },
499 "scopes": [ 1037 "scopes": [
500 "https://www.googleapis.com/auth/cloud-platform" , 1038 "https://www.googleapis.com/auth/cloud-platform" ,
501 "https://www.googleapis.com/auth/logging.admin" 1039 "https://www.googleapis.com/auth/logging.admin"
502 ] 1040 ]
503 } 1041 }
504 } 1042 }
505 }, 1043 },
506 "sinks": { 1044 "sinks": {
507 "methods": { 1045 "methods": {
508 "update": { 1046 "update": {
509 "description": "Updates or creates a sink.", 1047 "description": "Updates a sink. If the named sink do esn't exist, then this method is identical to sinks.create. If the named sink do es exist, then this method replaces the following fields in the existing sink wi th values from the new sink: destination, filter, output_version_format, start_t ime, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
510 "httpMethod": "PUT", 1048 "httpMethod": "PUT",
511 "id": "logging.organizations.sinks.update", 1049 "id": "logging.projects.sinks.update",
512 "parameterOrder": [ 1050 "parameterOrder": [
513 "sinkName" 1051 "sinkName"
514 ], 1052 ],
515 "parameters": { 1053 "parameters": {
516 "sinkName": { 1054 "sinkName": {
517 "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\"`.", 1055 "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
518 "location": "path", 1056 "location": "path",
519 "pattern": "^organizations/[^/]+/sinks/[^/]+ $", 1057 "pattern": "^projects/[^/]+/sinks/[^/]+$",
520 "required": true, 1058 "required": true,
521 "type": "string" 1059 "type": "string"
522 }, 1060 },
523 "uniqueWriterIdentity": { 1061 "uniqueWriterIdentity": {
524 "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.", 1062 "description": "Optional. See sinks.create f or a description of this field. When updating a sink, the effect of this field o n the value of writer_identity in the updated sink depends on both the old and n ew values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the ol d value was false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value was true and the new value is false.",
525 "location": "query", 1063 "location": "query",
526 "type": "boolean" 1064 "type": "boolean"
527 } 1065 }
528 }, 1066 },
529 "path": "v2/{+sinkName}", 1067 "path": "v2/{+sinkName}",
530 "request": { 1068 "request": {
531 "$ref": "LogSink" 1069 "$ref": "LogSink"
532 }, 1070 },
533 "response": { 1071 "response": {
534 "$ref": "LogSink" 1072 "$ref": "LogSink"
535 }, 1073 },
536 "scopes": [ 1074 "scopes": [
537 "https://www.googleapis.com/auth/cloud-platform" , 1075 "https://www.googleapis.com/auth/cloud-platform" ,
538 "https://www.googleapis.com/auth/logging.admin" 1076 "https://www.googleapis.com/auth/logging.admin"
539 ] 1077 ]
540 }, 1078 },
541 "get": { 1079 "get": {
542 "description": "Gets a sink.", 1080 "description": "Gets a sink.",
543 "httpMethod": "GET", 1081 "httpMethod": "GET",
544 "id": "logging.organizations.sinks.get", 1082 "id": "logging.projects.sinks.get",
545 "parameterOrder": [ 1083 "parameterOrder": [
546 "sinkName" 1084 "sinkName"
547 ], 1085 ],
548 "parameters": { 1086 "parameters": {
549 "sinkName": { 1087 "sinkName": {
550 "description": "Required. The resource name of the sink to return.\nExample: `\"projects/my-project-id/sinks/my-sink-id\"`." , 1088 "description": "Required. The parent resourc e name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/ [ORGANIZATION_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my- sink-id\".",
551 "location": "path", 1089 "location": "path",
552 "pattern": "^organizations/[^/]+/sinks/[^/]+ $", 1090 "pattern": "^projects/[^/]+/sinks/[^/]+$",
553 "required": true, 1091 "required": true,
554 "type": "string" 1092 "type": "string"
555 } 1093 }
556 }, 1094 },
557 "path": "v2/{+sinkName}", 1095 "path": "v2/{+sinkName}",
558 "response": { 1096 "response": {
559 "$ref": "LogSink" 1097 "$ref": "LogSink"
560 }, 1098 },
561 "scopes": [ 1099 "scopes": [
562 "https://www.googleapis.com/auth/cloud-platform" , 1100 "https://www.googleapis.com/auth/cloud-platform" ,
563 "https://www.googleapis.com/auth/cloud-platform. read-only", 1101 "https://www.googleapis.com/auth/cloud-platform. read-only",
564 "https://www.googleapis.com/auth/logging.admin", 1102 "https://www.googleapis.com/auth/logging.admin",
565 "https://www.googleapis.com/auth/logging.read" 1103 "https://www.googleapis.com/auth/logging.read"
566 ] 1104 ]
567 }, 1105 },
568 "create": { 1106 "create": {
569 "description": "Creates a sink.", 1107 "description": "Creates a sink that exports specifie d log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times o r the sink's writer_identity is not permitted to write to the destination. A sin k can export log entries only from the resource owning the sink.",
570 "httpMethod": "POST", 1108 "httpMethod": "POST",
571 "id": "logging.organizations.sinks.create", 1109 "id": "logging.projects.sinks.create",
572 "parameterOrder": [ 1110 "parameterOrder": [
573 "parent" 1111 "parent"
574 ], 1112 ],
575 "parameters": { 1113 "parameters": {
576 "uniqueWriterIdentity": { 1114 "uniqueWriterIdentity": {
577 "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.", 1115 "description": "Optional. Determines the kin d of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value r eturned as writer_identity is cloud-logs@google.com, the same identity used befo re the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from t he new sink. For more information, see writer_identity in LogSink.",
578 "location": "query", 1116 "location": "query",
579 "type": "boolean" 1117 "type": "boolean"
580 }, 1118 },
581 "parent": { 1119 "parent": {
582 "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.", 1120 "description": "Required. The resource in wh ich to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATIO N_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\". ",
583 "location": "path", 1121 "location": "path",
584 "pattern": "^organizations/[^/]+$", 1122 "pattern": "^projects/[^/]+$",
585 "required": true, 1123 "required": true,
586 "type": "string" 1124 "type": "string"
587 } 1125 }
588 }, 1126 },
589 "path": "v2/{+parent}/sinks", 1127 "path": "v2/{+parent}/sinks",
590 "request": { 1128 "request": {
591 "$ref": "LogSink" 1129 "$ref": "LogSink"
592 }, 1130 },
593 "response": { 1131 "response": {
594 "$ref": "LogSink" 1132 "$ref": "LogSink"
595 }, 1133 },
596 "scopes": [ 1134 "scopes": [
597 "https://www.googleapis.com/auth/cloud-platform" , 1135 "https://www.googleapis.com/auth/cloud-platform" ,
598 "https://www.googleapis.com/auth/logging.admin" 1136 "https://www.googleapis.com/auth/logging.admin"
599 ] 1137 ]
600 }, 1138 },
601 "list": { 1139 "list": {
602 "description": "Lists sinks.", 1140 "description": "Lists sinks.",
603 "httpMethod": "GET", 1141 "httpMethod": "GET",
604 "id": "logging.organizations.sinks.list", 1142 "id": "logging.projects.sinks.list",
605 "parameterOrder": [ 1143 "parameterOrder": [
606 "parent" 1144 "parent"
607 ], 1145 ],
608 "parameters": { 1146 "parameters": {
609 "pageSize": { 1147 "pageSize": {
610 "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.", 1148 "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The pr esence of nextPageToken in the response indicates that more results might be ava ilable.",
611 "format": "int32", 1149 "format": "int32",
612 "location": "query", 1150 "location": "query",
613 "type": "integer" 1151 "type": "integer"
614 }, 1152 },
615 "parent": { 1153 "parent": {
616 "description": "Required. The resource name where this sink was created.\nExample: `\"projects/my-logging-project\"`.", 1154 "description": "Required. The parent resourc e whose sinks are to be listed. Examples: \"projects/my-logging-project\", \"org anizations/123456789\".",
617 "location": "path", 1155 "location": "path",
618 "pattern": "^organizations/[^/]+$", 1156 "pattern": "^projects/[^/]+$",
619 "required": true, 1157 "required": true,
620 "type": "string" 1158 "type": "string"
621 }, 1159 },
622 "pageToken": { 1160 "pageToken": {
623 "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.", 1161 "description": "Optional. If present, then r etrieve the next batch of results from the preceding call to this method. pageTo ken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
624 "location": "query", 1162 "location": "query",
625 "type": "string" 1163 "type": "string"
626 } 1164 }
627 }, 1165 },
628 "path": "v2/{+parent}/sinks", 1166 "path": "v2/{+parent}/sinks",
629 "response": { 1167 "response": {
630 "$ref": "ListSinksResponse" 1168 "$ref": "ListSinksResponse"
631 }, 1169 },
632 "scopes": [ 1170 "scopes": [
633 "https://www.googleapis.com/auth/cloud-platform" , 1171 "https://www.googleapis.com/auth/cloud-platform" ,
634 "https://www.googleapis.com/auth/cloud-platform. read-only", 1172 "https://www.googleapis.com/auth/cloud-platform. read-only",
635 "https://www.googleapis.com/auth/logging.admin", 1173 "https://www.googleapis.com/auth/logging.admin",
636 "https://www.googleapis.com/auth/logging.read" 1174 "https://www.googleapis.com/auth/logging.read"
637 ] 1175 ]
638 }, 1176 },
639 "delete": { 1177 "delete": {
640 "description": "Deletes a sink.", 1178 "description": "Deletes a sink. If the sink has a un ique writer_identity, then that service account is also deleted.",
641 "httpMethod": "DELETE", 1179 "httpMethod": "DELETE",
642 "id": "logging.organizations.sinks.delete", 1180 "id": "logging.projects.sinks.delete",
643 "parameterOrder": [ 1181 "parameterOrder": [
644 "sinkName" 1182 "sinkName"
645 ], 1183 ],
646 "parameters": { 1184 "parameters": {
647 "sinkName": { 1185 "sinkName": {
648 "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.", 1186 "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifie r:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID] /sinks/[SINK_ID]\"\nIt is an error if the sink does not exist. Example: \"projec ts/my-project-id/sinks/my-sink-id\". It is an error if the sink does not exist." ,
649 "location": "path", 1187 "location": "path",
650 "pattern": "^organizations/[^/]+/sinks/[^/]+ $", 1188 "pattern": "^projects/[^/]+/sinks/[^/]+$",
651 "required": true, 1189 "required": true,
652 "type": "string" 1190 "type": "string"
653 } 1191 }
654 }, 1192 },
655 "path": "v2/{+sinkName}", 1193 "path": "v2/{+sinkName}",
656 "response": { 1194 "response": {
657 "$ref": "Empty" 1195 "$ref": "Empty"
658 }, 1196 },
659 "scopes": [ 1197 "scopes": [
660 "https://www.googleapis.com/auth/cloud-platform" , 1198 "https://www.googleapis.com/auth/cloud-platform" ,
661 "https://www.googleapis.com/auth/logging.admin" 1199 "https://www.googleapis.com/auth/logging.admin"
662 ] 1200 ]
663 } 1201 }
664 } 1202 }
665 } 1203 }
666 } 1204 }
667 }, 1205 },
668 "entries": { 1206 "entries": {
669 "methods": { 1207 "methods": {
670 "write": { 1208 "write": {
671 "description": "Writes log entries to Stackdriver Logging. All log entries are\nwritten by this method.", 1209 "description": "Writes log entries to Stackdriver Logging. A ll log entries are written by this method.",
672 "httpMethod": "POST", 1210 "httpMethod": "POST",
673 "id": "logging.entries.write", 1211 "id": "logging.entries.write",
674 "parameterOrder": [], 1212 "parameterOrder": [],
675 "parameters": {}, 1213 "parameters": {},
676 "path": "v2/entries:write", 1214 "path": "v2/entries:write",
677 "request": { 1215 "request": {
678 "$ref": "WriteLogEntriesRequest" 1216 "$ref": "WriteLogEntriesRequest"
679 }, 1217 },
680 "response": { 1218 "response": {
681 "$ref": "WriteLogEntriesResponse" 1219 "$ref": "WriteLogEntriesResponse"
682 }, 1220 },
683 "scopes": [ 1221 "scopes": [
684 "https://www.googleapis.com/auth/cloud-platform", 1222 "https://www.googleapis.com/auth/cloud-platform",
685 "https://www.googleapis.com/auth/logging.admin", 1223 "https://www.googleapis.com/auth/logging.admin",
686 "https://www.googleapis.com/auth/logging.write" 1224 "https://www.googleapis.com/auth/logging.write"
687 ] 1225 ]
688 }, 1226 },
689 "list": { 1227 "list": {
690 "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).", 1228 "description": "Lists log entries. Use this method to retrie ve log entries from Stackdriver Logging. For ways to export log entries, see Exp orting Logs.",
691 "httpMethod": "POST", 1229 "httpMethod": "POST",
692 "id": "logging.entries.list", 1230 "id": "logging.entries.list",
693 "parameterOrder": [], 1231 "parameterOrder": [],
694 "parameters": {}, 1232 "parameters": {},
695 "path": "v2/entries:list", 1233 "path": "v2/entries:list",
696 "request": { 1234 "request": {
697 "$ref": "ListLogEntriesRequest" 1235 "$ref": "ListLogEntriesRequest"
698 }, 1236 },
699 "response": { 1237 "response": {
700 "$ref": "ListLogEntriesResponse" 1238 "$ref": "ListLogEntriesResponse"
701 }, 1239 },
702 "scopes": [ 1240 "scopes": [
703 "https://www.googleapis.com/auth/cloud-platform", 1241 "https://www.googleapis.com/auth/cloud-platform",
704 "https://www.googleapis.com/auth/cloud-platform.read-onl y", 1242 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
705 "https://www.googleapis.com/auth/logging.admin", 1243 "https://www.googleapis.com/auth/logging.admin",
706 "https://www.googleapis.com/auth/logging.read" 1244 "https://www.googleapis.com/auth/logging.read"
707 ] 1245 ]
708 } 1246 }
709 } 1247 }
710 }, 1248 },
711 "monitoredResourceDescriptors": { 1249 "monitoredResourceDescriptors": {
712 "methods": { 1250 "methods": {
713 "list": { 1251 "list": {
714 "description": "Lists the monitored resource descriptors use d by Stackdriver Logging.", 1252 "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
715 "httpMethod": "GET", 1253 "httpMethod": "GET",
716 "id": "logging.monitoredResourceDescriptors.list", 1254 "id": "logging.monitoredResourceDescriptors.list",
717 "parameterOrder": [], 1255 "parameterOrder": [],
718 "parameters": { 1256 "parameters": {
719 "pageSize": { 1257 "pageSize": {
720 "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.", 1258 "description": "Optional. The maximum number of resu lts to return from this request. Non-positive values are ignored. The presence o f nextPageToken in the response indicates that more results might be available." ,
721 "format": "int32", 1259 "format": "int32",
722 "location": "query", 1260 "location": "query",
723 "type": "integer" 1261 "type": "integer"
724 }, 1262 },
725 "pageToken": { 1263 "pageToken": {
726 "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.", 1264 "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other m ethod parameters should be identical to those in the previous call.",
727 "location": "query", 1265 "location": "query",
728 "type": "string" 1266 "type": "string"
729 } 1267 }
730 }, 1268 },
731 "path": "v2/monitoredResourceDescriptors", 1269 "path": "v2/monitoredResourceDescriptors",
732 "response": { 1270 "response": {
733 "$ref": "ListMonitoredResourceDescriptorsResponse" 1271 "$ref": "ListMonitoredResourceDescriptorsResponse"
734 }, 1272 },
735 "scopes": [ 1273 "scopes": [
736 "https://www.googleapis.com/auth/cloud-platform", 1274 "https://www.googleapis.com/auth/cloud-platform",
737 "https://www.googleapis.com/auth/cloud-platform.read-onl y", 1275 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
738 "https://www.googleapis.com/auth/logging.admin", 1276 "https://www.googleapis.com/auth/logging.admin",
739 "https://www.googleapis.com/auth/logging.read" 1277 "https://www.googleapis.com/auth/logging.read"
740 ] 1278 ]
741 } 1279 }
742 } 1280 }
743 },
744 "billingAccounts": {
745 "resources": {
746 "logs": {
747 "methods": {
748 "delete": {
749 "description": "Deletes a log and all its log entrie s.\nThe log will reappear if it receives new entries.",
750 "httpMethod": "DELETE",
751 "id": "logging.billingAccounts.logs.delete",
752 "parameterOrder": [
753 "logName"
754 ],
755 "parameters": {
756 "logName": {
757 "description": "Required. The resource name of the log to delete. Example:\n`\"projects/my-project/logs/syslog\"`.",
758 "location": "path",
759 "pattern": "^billingAccounts/[^/]+/logs/[^/] +$",
760 "required": true,
761 "type": "string"
762 }
763 },
764 "path": "v2/{+logName}",
765 "response": {
766 "$ref": "Empty"
767 },
768 "scopes": [
769 "https://www.googleapis.com/auth/cloud-platform" ,
770 "https://www.googleapis.com/auth/logging.admin"
771 ]
772 }
773 }
774 },
775 "sinks": {
776 "methods": {
777 "update": {
778 "description": "Updates or creates a sink.",
779 "httpMethod": "PUT",
780 "id": "logging.billingAccounts.sinks.update",
781 "parameterOrder": [
782 "sinkName"
783 ],
784 "parameters": {
785 "sinkName": {
786 "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\"`.",
787 "location": "path",
788 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
789 "required": true,
790 "type": "string"
791 },
792 "uniqueWriterIdentity": {
793 "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.",
794 "location": "query",
795 "type": "boolean"
796 }
797 },
798 "path": "v2/{+sinkName}",
799 "request": {
800 "$ref": "LogSink"
801 },
802 "response": {
803 "$ref": "LogSink"
804 },
805 "scopes": [
806 "https://www.googleapis.com/auth/cloud-platform" ,
807 "https://www.googleapis.com/auth/logging.admin"
808 ]
809 },
810 "get": {
811 "description": "Gets a sink.",
812 "httpMethod": "GET",
813 "id": "logging.billingAccounts.sinks.get",
814 "parameterOrder": [
815 "sinkName"
816 ],
817 "parameters": {
818 "sinkName": {
819 "description": "Required. The resource name of the sink to return.\nExample: `\"projects/my-project-id/sinks/my-sink-id\"`." ,
820 "location": "path",
821 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
822 "required": true,
823 "type": "string"
824 }
825 },
826 "path": "v2/{+sinkName}",
827 "response": {
828 "$ref": "LogSink"
829 },
830 "scopes": [
831 "https://www.googleapis.com/auth/cloud-platform" ,
832 "https://www.googleapis.com/auth/cloud-platform. read-only",
833 "https://www.googleapis.com/auth/logging.admin",
834 "https://www.googleapis.com/auth/logging.read"
835 ]
836 },
837 "create": {
838 "description": "Creates a sink.",
839 "httpMethod": "POST",
840 "id": "logging.billingAccounts.sinks.create",
841 "parameterOrder": [
842 "parent"
843 ],
844 "parameters": {
845 "uniqueWriterIdentity": {
846 "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.",
847 "location": "query",
848 "type": "boolean"
849 },
850 "parent": {
851 "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.",
852 "location": "path",
853 "pattern": "^billingAccounts/[^/]+$",
854 "required": true,
855 "type": "string"
856 }
857 },
858 "path": "v2/{+parent}/sinks",
859 "request": {
860 "$ref": "LogSink"
861 },
862 "response": {
863 "$ref": "LogSink"
864 },
865 "scopes": [
866 "https://www.googleapis.com/auth/cloud-platform" ,
867 "https://www.googleapis.com/auth/logging.admin"
868 ]
869 },
870 "list": {
871 "description": "Lists sinks.",
872 "httpMethod": "GET",
873 "id": "logging.billingAccounts.sinks.list",
874 "parameterOrder": [
875 "parent"
876 ],
877 "parameters": {
878 "pageSize": {
879 "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.",
880 "format": "int32",
881 "location": "query",
882 "type": "integer"
883 },
884 "parent": {
885 "description": "Required. The resource name where this sink was created.\nExample: `\"projects/my-logging-project\"`.",
886 "location": "path",
887 "pattern": "^billingAccounts/[^/]+$",
888 "required": true,
889 "type": "string"
890 },
891 "pageToken": {
892 "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.",
893 "location": "query",
894 "type": "string"
895 }
896 },
897 "path": "v2/{+parent}/sinks",
898 "response": {
899 "$ref": "ListSinksResponse"
900 },
901 "scopes": [
902 "https://www.googleapis.com/auth/cloud-platform" ,
903 "https://www.googleapis.com/auth/cloud-platform. read-only",
904 "https://www.googleapis.com/auth/logging.admin",
905 "https://www.googleapis.com/auth/logging.read"
906 ]
907 },
908 "delete": {
909 "description": "Deletes a sink.",
910 "httpMethod": "DELETE",
911 "id": "logging.billingAccounts.sinks.delete",
912 "parameterOrder": [
913 "sinkName"
914 ],
915 "parameters": {
916 "sinkName": {
917 "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.",
918 "location": "path",
919 "pattern": "^billingAccounts/[^/]+/sinks/[^/ ]+$",
920 "required": true,
921 "type": "string"
922 }
923 },
924 "path": "v2/{+sinkName}",
925 "response": {
926 "$ref": "Empty"
927 },
928 "scopes": [
929 "https://www.googleapis.com/auth/cloud-platform" ,
930 "https://www.googleapis.com/auth/logging.admin"
931 ]
932 }
933 }
934 }
935 }
936 } 1281 }
937 }, 1282 },
938 "revision": "20161028", 1283 "revision": "20161206",
939 "rootUrl": "https://logging.googleapis.com/", 1284 "rootUrl": "https://logging.googleapis.com/",
940 "schemas": { 1285 "schemas": {
941 "ListLogEntriesResponse": { 1286 "ListLogEntriesResponse": {
942 "description": "Result returned from `ListLogEntries`.", 1287 "description": "Result returned from ListLogEntries.",
943 "id": "ListLogEntriesResponse", 1288 "id": "ListLogEntriesResponse",
944 "properties": { 1289 "properties": {
945 "entries": { 1290 "entries": {
946 "description": "A list of log entries.", 1291 "description": "A list of log entries.",
947 "items": { 1292 "items": {
948 "$ref": "LogEntry" 1293 "$ref": "LogEntry"
949 }, 1294 },
950 "type": "array" 1295 "type": "array"
951 }, 1296 },
952 "nextPageToken": { 1297 "nextPageToken": {
953 "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`." , 1298 "description": "If there might be more results than those ap pearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.I f a value for next_page_token appears and the entries field is empty, it means t hat the search found no log entries so far but it did not have time to search al l the possible log entries. Retry the method with this value for page_token to c ontinue the search. Alternatively, consider speeding up the search by changing y our filter to specify a single log name or resource type, or to narrow the time range of the search.",
954 "type": "string" 1299 "type": "string"
955 } 1300 }
956 }, 1301 },
957 "type": "object" 1302 "type": "object"
958 }, 1303 },
959 "ListSinksResponse": { 1304 "ListSinksResponse": {
960 "description": "Result returned from `ListSinks`.", 1305 "description": "Result returned from ListSinks.",
961 "id": "ListSinksResponse", 1306 "id": "ListSinksResponse",
962 "properties": { 1307 "properties": {
963 "nextPageToken": { 1308 "nextPageToken": {
964 "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`.", 1309 "description": "If there might be more results than appear i n this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
965 "type": "string" 1310 "type": "string"
966 }, 1311 },
967 "sinks": { 1312 "sinks": {
968 "description": "A list of sinks.", 1313 "description": "A list of sinks.",
969 "items": { 1314 "items": {
970 "$ref": "LogSink" 1315 "$ref": "LogSink"
971 }, 1316 },
972 "type": "array" 1317 "type": "array"
973 } 1318 }
974 }, 1319 },
975 "type": "object" 1320 "type": "object"
976 }, 1321 },
977 "SourceLocation": { 1322 "SourceLocation": {
978 "description": "Specifies a location in a source code file.", 1323 "description": "Specifies a location in a source code file.",
979 "id": "SourceLocation", 1324 "id": "SourceLocation",
980 "properties": { 1325 "properties": {
981 "file": { 1326 "file": {
982 "description": "Source file name. Depending on the runtime e nvironment, this might be a\nsimple name or a fully-qualified name.", 1327 "description": "Source file name. Depending on the runtime e nvironment, this might be a simple name or a fully-qualified name.",
983 "type": "string" 1328 "type": "string"
984 }, 1329 },
985 "functionName": { 1330 "functionName": {
986 "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).", 1331 "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).",
987 "type": "string" 1332 "type": "string"
988 }, 1333 },
989 "line": { 1334 "line": {
990 "description": "Line within the source file.", 1335 "description": "Line within the source file.",
991 "format": "int64", 1336 "format": "int64",
992 "type": "string" 1337 "type": "string"
993 } 1338 }
994 }, 1339 },
995 "type": "object" 1340 "type": "object"
996 }, 1341 },
997 "LogSink": { 1342 "LogSink": {
998 "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` .", 1343 "description": "Describes a sink used to export log entries to one o f the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project or organization.",
999 "id": "LogSink", 1344 "id": "LogSink",
1000 "properties": { 1345 "properties": {
1001 "destination": { 1346 "destination": {
1002 "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\"", 1347 "description": "Required. The export destination:\n\"storage .googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/ datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPI C_ID]\"\nThe sink's writer_identity, set when the sink is created, must have per mission to write to the destination or else the log entries are not exported. Fo r more information, see Exporting Logs With Sinks.",
1003 "type": "string" 1348 "type": "string"
1004 }, 1349 },
1005 "filter": { 1350 "filter": {
1006 "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", 1351 "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the out put_version_format parameter. For example, in the v2 format:\nlogName=\"projects /[PROJECT_ID]/logs/[LOG_ID]\" AND severity>=ERROR\n",
1007 "type": "string" 1352 "type": "string"
1008 }, 1353 },
1009 "endTime": { 1354 "endTime": {
1010 "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`.", 1355 "description": "Optional. The time at which this sink will s top exporting log entries. Log entries are exported only if their timestamp is e arlier than the end time. If this field is not supplied, there is no end time. I f both a start time and an end time are provided, then the end time must be late r than the start time.",
1011 "format": "google-datetime", 1356 "format": "google-datetime",
1012 "type": "string" 1357 "type": "string"
1013 }, 1358 },
1014 "name": { 1359 "name": {
1015 "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.", 1360 "description": "Required. The client-assigned sink identifie r, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink iden tifiers are limited to 100 characters and can include only the following charact ers: upper and lower-case alphanumeric characters, underscores, hyphens, and per iods.",
1016 "type": "string" 1361 "type": "string"
1017 }, 1362 },
1018 "startTime": { 1363 "startTime": {
1019 "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`.", 1364 "description": "Optional. The time at which this sink will b egin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.",
1020 "format": "google-datetime", 1365 "format": "google-datetime",
1021 "type": "string" 1366 "type": "string"
1022 }, 1367 },
1023 "outputVersionFormat": { 1368 "outputVersionFormat": {
1024 "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.", 1369 "description": "Optional. The log entry format to use for th is sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See M igration to the v2 API.",
1025 "enum": [ 1370 "enum": [
1026 "VERSION_FORMAT_UNSPECIFIED", 1371 "VERSION_FORMAT_UNSPECIFIED",
1027 "V2", 1372 "V2",
1028 "V1" 1373 "V1"
1029 ], 1374 ],
1030 "enumDescriptions": [ 1375 "enumDescriptions": [
1031 "An unspecified version format will default to V2.", 1376 "An unspecified format version that will default to V2." ,
1032 "`LogEntry` version 2 format.", 1377 "LogEntry version 2 format.",
1033 "`LogEntry` version 1 format." 1378 "LogEntry version 1 format."
1034 ], 1379 ],
1035 "type": "string" 1380 "type": "string"
1036 }, 1381 },
1037 "writerIdentity": { 1382 "writerIdentity": {
1038 "description": "Output only. An IAM identity&mdash;a service account or group&mdash;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.", 1383 "description": "Output only. An IAM identity&mdash;a service account or group&mdash;under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.u pdate, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from thi s sink will fail. For more information, see Granting access for a resource. Cons ult the destination service's documentation to determine the appropriate IAM rol es to assign to the identity.",
1384 "type": "string"
1385 }
1386 },
1387 "type": "object"
1388 },
1389 "ListLogsResponse": {
1390 "description": "Result returned from ListLogs.",
1391 "id": "ListLogsResponse",
1392 "properties": {
1393 "logNames": {
1394 "description": "A list of log names. For example, \"projects /my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com% 2Factivity\".",
1395 "items": {
1396 "type": "string"
1397 },
1398 "type": "array"
1399 },
1400 "nextPageToken": {
1401 "description": "If there might be more results than those ap pearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken." ,
1039 "type": "string" 1402 "type": "string"
1040 } 1403 }
1041 }, 1404 },
1042 "type": "object" 1405 "type": "object"
1043 }, 1406 },
1044 "LogMetric": { 1407 "LogMetric": {
1045 "description": "Describes a logs-based metric. The value of the met ric is the\nnumber of log entries that match a logs filter.", 1408 "description": "Describes a logs-based metric. The value of the metr ic is the number of log entries that match a logs filter in a given time interva l.",
1046 "id": "LogMetric", 1409 "id": "LogMetric",
1047 "properties": { 1410 "properties": {
1048 "description": { 1411 "description": {
1049 "description": "Optional. A description of this metric, whic h is used in documentation.", 1412 "description": "Optional. A description of this metric, whic h is used in documentation.",
1050 "type": "string" 1413 "type": "string"
1051 }, 1414 },
1052 "filter": { 1415 "filter": {
1053 "description": "Required. An [advanced logs filter](/logging /docs/view/advanced_filters).\nExample: `\"resource.type=gae_app AND severity>=E RROR\"`.", 1416 "description": "Required. An advanced logs filter which is u sed to match log entries. Example:\n\"resource.type=gae_app AND severity>=ERROR\ "\nThe maximum length of the filter is 20000 characters.",
1054 "type": "string" 1417 "type": "string"
1055 }, 1418 },
1056 "name": { 1419 "name": {
1057 "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.", 1420 "description": "Required. The client-assigned metric identif ier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limite d to 100 characters and can include only the following characters: A-Z, a-z, 0-9 , and the special characters _-.,+!*',()%/. The forward-slash character (/) deno tes a hierarchy of name pieces, and it cannot be the first character of the name .The metric identifier in this field must not be URL-encoded (https://en.wikiped ia.org/wiki/Percent-encoding). However, when the metric identifier appears as th e [METRIC_ID] part of a metric_name API parameter, then the metric identifier mu st be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".",
1058 "type": "string" 1421 "type": "string"
1059 }, 1422 },
1060 "version": { 1423 "version": {
1061 "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.", 1424 "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter express ion. When a value for this field is missing, the default value of V2 should be a ssumed.",
1062 "enum": [ 1425 "enum": [
1063 "V2", 1426 "V2",
1064 "V1" 1427 "V1"
1065 ], 1428 ],
1066 "enumDescriptions": [ 1429 "enumDescriptions": [
1067 "Stackdriver Logging API v2.", 1430 "Stackdriver Logging API v2.",
1068 "Stackdriver Logging API v1." 1431 "Stackdriver Logging API v1."
1069 ], 1432 ],
1070 "type": "string" 1433 "type": "string"
1071 } 1434 }
1072 }, 1435 },
1073 "type": "object" 1436 "type": "object"
1074 }, 1437 },
1075 "LogEntry": { 1438 "LogEntry": {
1076 "description": "An individual entry in a log.", 1439 "description": "An individual entry in a log.",
1077 "id": "LogEntry", 1440 "id": "LogEntry",
1078 "properties": { 1441 "properties": {
1079 "textPayload": { 1442 "textPayload": {
1080 "description": "The log entry payload, represented as a Unic ode string (UTF-8).", 1443 "description": "The log entry payload, represented as a Unic ode string (UTF-8).",
1081 "type": "string" 1444 "type": "string"
1082 }, 1445 },
1083 "httpRequest": { 1446 "httpRequest": {
1084 "$ref": "HttpRequest", 1447 "$ref": "HttpRequest",
1085 "description": "Optional. Information about the HTTP request associated with this\nlog entry, if applicable." 1448 "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
1449 },
1450 "sourceLocation": {
1451 "$ref": "LogEntrySourceLocation",
1452 "description": "Optional. Source code location information a ssociated with the log entry, if any."
1086 }, 1453 },
1087 "jsonPayload": { 1454 "jsonPayload": {
1088 "additionalProperties": { 1455 "additionalProperties": {
1089 "description": "Properties of the object.", 1456 "description": "Properties of the object.",
1090 "type": "any" 1457 "type": "any"
1091 }, 1458 },
1092 "description": "The log entry payload, represented as a stru cture that\nis expressed as a JSON object.", 1459 "description": "The log entry payload, represented as a stru cture that is expressed as a JSON object.",
1093 "type": "object" 1460 "type": "object"
1094 }, 1461 },
1095 "labels": { 1462 "labels": {
1096 "additionalProperties": { 1463 "additionalProperties": {
1097 "type": "string" 1464 "type": "string"
1098 }, 1465 },
1099 "description": "Optional. A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", 1466 "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
1100 "type": "object" 1467 "type": "object"
1101 }, 1468 },
1469 "trace": {
1470 "description": "Optional. Resource name of the trace associa ted with the log entry, if any. If it contains a relative resource name, the nam e is assumed to be relative to //tracing.googleapis.com. Example: projects/my-pr ojectid/traces/06796866738c859f2f19b7cfb3214824",
1471 "type": "string"
1472 },
1102 "logName": { 1473 "logName": {
1103 "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.", 1474 "description": "Required. The resource name of the log to wh ich this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organiza tions/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log _name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis. com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only in clude the following characters: upper and lower case alphanumeric characters, fo rward-slash, underscore, hyphen, and period.For backward compatibility, if log_n ame begins with a forward-slash, such as /projects/..., then the log entry is in gested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will n ever return any results.",
1104 "type": "string" 1475 "type": "string"
1105 }, 1476 },
1106 "severity": { 1477 "severity": {
1107 "description": "Optional. The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.", 1478 "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
1108 "enum": [ 1479 "enum": [
1109 "DEFAULT", 1480 "DEFAULT",
1110 "DEBUG", 1481 "DEBUG",
1111 "INFO", 1482 "INFO",
1112 "NOTICE", 1483 "NOTICE",
1113 "WARNING", 1484 "WARNING",
1114 "ERROR", 1485 "ERROR",
1115 "CRITICAL", 1486 "CRITICAL",
1116 "ALERT", 1487 "ALERT",
1117 "EMERGENCY" 1488 "EMERGENCY"
1118 ], 1489 ],
1119 "enumDescriptions": [ 1490 "enumDescriptions": [
1120 "(0) The log entry has no assigned severity level.", 1491 "(0) The log entry has no assigned severity level.",
1121 "(100) Debug or trace information.", 1492 "(100) Debug or trace information.",
1122 "(200) Routine information, such as ongoing status or pe rformance.", 1493 "(200) Routine information, such as ongoing status or pe rformance.",
1123 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", 1494 "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
1124 "(400) Warning events might cause problems.", 1495 "(400) Warning events might cause problems.",
1125 "(500) Error events are likely to cause problems.", 1496 "(500) Error events are likely to cause problems.",
1126 "(600) Critical events cause more severe problems or out ages.", 1497 "(600) Critical events cause more severe problems or out ages.",
1127 "(700) A person must take an action immediately.", 1498 "(700) A person must take an action immediately.",
1128 "(800) One or more systems are unusable." 1499 "(800) One or more systems are unusable."
1129 ], 1500 ],
1130 "type": "string" 1501 "type": "string"
1131 }, 1502 },
1132 "resource": { 1503 "resource": {
1133 "$ref": "MonitoredResource", 1504 "$ref": "MonitoredResource",
1134 "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." 1505 "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."
1135 }, 1506 },
1136 "protoPayload": { 1507 "protoPayload": {
1137 "additionalProperties": { 1508 "additionalProperties": {
1138 "description": "Properties of the object. Contains field @type with type URL.", 1509 "description": "Properties of the object. Contains field @type with type URL.",
1139 "type": "any" 1510 "type": "any"
1140 }, 1511 },
1141 "description": "The log entry payload, represented as a prot ocol buffer. Some\nGoogle Cloud Platform services use this field for their log\ nentry payloads.", 1512 "description": "The log entry payload, represented as a prot ocol buffer. Some Google Cloud Platform services use this field for their log en try payloads.",
1142 "type": "object" 1513 "type": "object"
1143 }, 1514 },
1144 "timestamp": { 1515 "timestamp": {
1145 "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.", 1516 "description": "Optional. The time the event described by th e log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received.",
1146 "format": "google-datetime", 1517 "format": "google-datetime",
1147 "type": "string" 1518 "type": "string"
1148 }, 1519 },
1149 "insertId": { 1520 "insertId": {
1150 "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.", 1521 "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 project with the same ID as duplicates which can be removed. If omitted, Sta ckdriver Logging will generate a unique ID for this log entry.",
1151 "type": "string" 1522 "type": "string"
1152 }, 1523 },
1153 "operation": { 1524 "operation": {
1154 "$ref": "LogEntryOperation", 1525 "$ref": "LogEntryOperation",
1155 "description": "Optional. Information about an operation ass ociated with the log entry, if\napplicable." 1526 "description": "Optional. Information about an operation ass ociated with the log entry, if applicable."
1156 } 1527 }
1157 }, 1528 },
1158 "type": "object" 1529 "type": "object"
1159 }, 1530 },
1160 "LogLine": { 1531 "LogLine": {
1161 "description": "Application log line emitted while processing a requ est.", 1532 "description": "Application log line emitted while processing a requ est.",
1162 "id": "LogLine", 1533 "id": "LogLine",
1163 "properties": { 1534 "properties": {
1164 "time": { 1535 "time": {
1165 "description": "Approximate time when this log entry was mad e.", 1536 "description": "Approximate time when this log entry was mad e.",
(...skipping 10 matching lines...) Expand all
1176 "WARNING", 1547 "WARNING",
1177 "ERROR", 1548 "ERROR",
1178 "CRITICAL", 1549 "CRITICAL",
1179 "ALERT", 1550 "ALERT",
1180 "EMERGENCY" 1551 "EMERGENCY"
1181 ], 1552 ],
1182 "enumDescriptions": [ 1553 "enumDescriptions": [
1183 "(0) The log entry has no assigned severity level.", 1554 "(0) The log entry has no assigned severity level.",
1184 "(100) Debug or trace information.", 1555 "(100) Debug or trace information.",
1185 "(200) Routine information, such as ongoing status or pe rformance.", 1556 "(200) Routine information, such as ongoing status or pe rformance.",
1186 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", 1557 "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
1187 "(400) Warning events might cause problems.", 1558 "(400) Warning events might cause problems.",
1188 "(500) Error events are likely to cause problems.", 1559 "(500) Error events are likely to cause problems.",
1189 "(600) Critical events cause more severe problems or out ages.", 1560 "(600) Critical events cause more severe problems or out ages.",
1190 "(700) A person must take an action immediately.", 1561 "(700) A person must take an action immediately.",
1191 "(800) One or more systems are unusable." 1562 "(800) One or more systems are unusable."
1192 ], 1563 ],
1193 "type": "string" 1564 "type": "string"
1194 }, 1565 },
1195 "sourceLocation": { 1566 "sourceLocation": {
1196 "$ref": "SourceLocation", 1567 "$ref": "SourceLocation",
1197 "description": "Where in the source code this log message wa s written." 1568 "description": "Where in the source code this log message wa s written."
1198 }, 1569 },
1199 "logMessage": { 1570 "logMessage": {
1200 "description": "App-provided log message.", 1571 "description": "App-provided log message.",
1201 "type": "string" 1572 "type": "string"
1202 } 1573 }
1203 }, 1574 },
1204 "type": "object" 1575 "type": "object"
1205 }, 1576 },
1206 "SourceReference": { 1577 "SourceReference": {
1207 "description": "A reference to a particular snapshot of the source t ree used to build and\ndeploy an application.", 1578 "description": "A reference to a particular snapshot of the source t ree used to build and deploy an application.",
1208 "id": "SourceReference", 1579 "id": "SourceReference",
1209 "properties": { 1580 "properties": {
1210 "repository": { 1581 "repository": {
1211 "description": "Optional. A URI string identifying the repos itory.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", 1582 "description": "Optional. A URI string identifying the repos itory. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
1212 "type": "string" 1583 "type": "string"
1213 }, 1584 },
1214 "revisionId": { 1585 "revisionId": {
1215 "description": "The canonical and persistent identifier of t he deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b \"", 1586 "description": "The canonical and persistent identifier of t he deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\ "",
1216 "type": "string" 1587 "type": "string"
1217 } 1588 }
1218 }, 1589 },
1219 "type": "object" 1590 "type": "object"
1220 }, 1591 },
1221 "MonitoredResource": { 1592 "MonitoredResource": {
1222 "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\" }}", 1593 "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 ide ntifies a MonitoredResourceDescriptor object that describes the resource's schem a. Information in the labels field identifies the actual resource and its attrib utes according to the schema. For example, a particular Compute Engine VM instan ce could be represented by the following object, because the MonitoredResourceDe scriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type \": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
1223 "id": "MonitoredResource", 1594 "id": "MonitoredResource",
1224 "properties": { 1595 "properties": {
1225 "labels": { 1596 "labels": {
1226 "additionalProperties": { 1597 "additionalProperties": {
1227 "type": "string" 1598 "type": "string"
1228 }, 1599 },
1229 "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\"`.", 1600 "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\".",
1230 "type": "object" 1601 "type": "object"
1231 }, 1602 },
1232 "type": { 1603 "type": {
1233 "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\"`.", 1604 "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For exa mple, the type of a Cloud SQL database is \"cloudsql_database\".",
1234 "type": "string" 1605 "type": "string"
1235 } 1606 }
1236 }, 1607 },
1237 "type": "object" 1608 "type": "object"
1238 }, 1609 },
1239 "WriteLogEntriesRequest": { 1610 "WriteLogEntriesRequest": {
1240 "description": "The parameters to WriteLogEntries.", 1611 "description": "The parameters to WriteLogEntries.",
1241 "id": "WriteLogEntriesRequest", 1612 "id": "WriteLogEntriesRequest",
1242 "properties": { 1613 "properties": {
1243 "labels": { 1614 "labels": {
1244 "additionalProperties": { 1615 "additionalProperties": {
1245 "type": "string" 1616 "type": "string"
1246 }, 1617 },
1247 "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.", 1618 "description": "Optional. Default labels that are added to t he labels field of all log entries in entries. If a log entry already has a labe l with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
1248 "type": "object" 1619 "type": "object"
1249 }, 1620 },
1250 "entries": { 1621 "entries": {
1251 "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.", 1622 "description": "Required. The log entries to write. Values s upplied for the fields log_name, resource, and labels in this entries.write requ est are added to those log entries that do not provide their own values for the fields.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than callin g this method for each individual log entry.",
1252 "items": { 1623 "items": {
1253 "$ref": "LogEntry" 1624 "$ref": "LogEntry"
1254 }, 1625 },
1255 "type": "array" 1626 "type": "array"
1256 }, 1627 },
1257 "logName": { 1628 "logName": {
1258 "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.", 1629 "description": "Optional. A default log resource name that i s assigned to all log entries in entries that do not specify a value for log_nam e:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/l ogs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project -id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.google apis.com%2Factivity\". For more information about log names, see LogEntry.",
1259 "type": "string" 1630 "type": "string"
1260 }, 1631 },
1261 "partialSuccess": { 1632 "partialSuccess": {
1262 "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.", 1633 "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.",
1263 "type": "boolean" 1634 "type": "boolean"
1264 }, 1635 },
1265 "resource": { 1636 "resource": {
1266 "$ref": "MonitoredResource", 1637 "$ref": "MonitoredResource",
1267 "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." 1638 "description": "Optional. A default monitored resource objec t that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\ ": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry ."
1268 } 1639 }
1269 }, 1640 },
1270 "type": "object" 1641 "type": "object"
1271 }, 1642 },
1272 "LabelDescriptor": { 1643 "LabelDescriptor": {
1273 "description": "A description of a label.", 1644 "description": "A description of a label.",
1274 "id": "LabelDescriptor", 1645 "id": "LabelDescriptor",
1275 "properties": { 1646 "properties": {
1276 "description": { 1647 "description": {
1277 "description": "A human-readable description for the label." , 1648 "description": "A human-readable description for the label." ,
(...skipping 25 matching lines...) Expand all
1303 "id": "ListLogMetricsResponse", 1674 "id": "ListLogMetricsResponse",
1304 "properties": { 1675 "properties": {
1305 "metrics": { 1676 "metrics": {
1306 "description": "A list of logs-based metrics.", 1677 "description": "A list of logs-based metrics.",
1307 "items": { 1678 "items": {
1308 "$ref": "LogMetric" 1679 "$ref": "LogMetric"
1309 }, 1680 },
1310 "type": "array" 1681 "type": "array"
1311 }, 1682 },
1312 "nextPageToken": { 1683 "nextPageToken": {
1313 "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`." , 1684 "description": "If there might be more results than appear i n this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
1314 "type": "string" 1685 "type": "string"
1315 } 1686 }
1316 }, 1687 },
1317 "type": "object" 1688 "type": "object"
1318 }, 1689 },
1319 "MonitoredResourceDescriptor": { 1690 "MonitoredResourceDescriptor": {
1320 "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.", 1691 "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_i nstance\" and specifies the use of the labels \"instance_id\" and \"zone\" to id entify particular VM instances.Different APIs can support different monitored re source types. APIs generally provide a list method that returns the monitored re source descriptors used by the API.",
1321 "id": "MonitoredResourceDescriptor", 1692 "id": "MonitoredResourceDescriptor",
1322 "properties": { 1693 "properties": {
1323 "displayName": { 1694 "displayName": {
1324 "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\"`.", 1695 "description": "Optional. A concise name for the monitored r esource type that might be displayed in user interfaces. It should be a Title Ca sed Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
1325 "type": "string" 1696 "type": "string"
1326 }, 1697 },
1327 "description": { 1698 "description": {
1328 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.", 1699 "description": "Optional. A detailed description of the moni tored resource type that might be used in documentation.",
1329 "type": "string" 1700 "type": "string"
1330 }, 1701 },
1331 "labels": { 1702 "labels": {
1332 "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\"`.", 1703 "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 \"zone \".",
1333 "items": { 1704 "items": {
1334 "$ref": "LabelDescriptor" 1705 "$ref": "LabelDescriptor"
1335 }, 1706 },
1336 "type": "array" 1707 "type": "array"
1337 }, 1708 },
1338 "type": { 1709 "type": {
1339 "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.", 1710 "description": "Required. The monitored resource type. For e xample, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
1340 "type": "string" 1711 "type": "string"
1341 }, 1712 },
1342 "name": { 1713 "name": {
1343 "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}\"`.", 1714 "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type }\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitored ResourceDescriptors/{type}\".",
1344 "type": "string" 1715 "type": "string"
1345 } 1716 }
1346 }, 1717 },
1347 "type": "object" 1718 "type": "object"
1348 }, 1719 },
1349 "ListMonitoredResourceDescriptorsResponse": { 1720 "ListMonitoredResourceDescriptorsResponse": {
1350 "description": "Result returned from ListMonitoredResourceDescriptor s.", 1721 "description": "Result returned from ListMonitoredResourceDescriptor s.",
1351 "id": "ListMonitoredResourceDescriptorsResponse", 1722 "id": "ListMonitoredResourceDescriptorsResponse",
1352 "properties": { 1723 "properties": {
1353 "nextPageToken": { 1724 "nextPageToken": {
1354 "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`." , 1725 "description": "If there might be more results than those ap pearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken." ,
1355 "type": "string" 1726 "type": "string"
1356 }, 1727 },
1357 "resourceDescriptors": { 1728 "resourceDescriptors": {
1358 "description": "A list of resource descriptors.", 1729 "description": "A list of resource descriptors.",
1359 "items": { 1730 "items": {
1360 "$ref": "MonitoredResourceDescriptor" 1731 "$ref": "MonitoredResourceDescriptor"
1361 }, 1732 },
1362 "type": "array" 1733 "type": "array"
1363 } 1734 }
1364 }, 1735 },
1365 "type": "object" 1736 "type": "object"
1366 }, 1737 },
1367 "LogEntryOperation": { 1738 "LogEntryOperation": {
1368 "description": "Additional information about a potentially long-runn ing operation with which\na log entry is associated.", 1739 "description": "Additional information about a potentially long-runn ing operation with which a log entry is associated.",
1369 "id": "LogEntryOperation", 1740 "id": "LogEntryOperation",
1370 "properties": { 1741 "properties": {
1371 "producer": { 1742 "producer": {
1372 "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\"`.", 1743 "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for produce r: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
1373 "type": "string" 1744 "type": "string"
1374 }, 1745 },
1375 "last": { 1746 "last": {
1376 "description": "Optional. Set this to True if this is the la st log entry in the operation.", 1747 "description": "Optional. Set this to True if this is the la st log entry in the operation.",
1377 "type": "boolean" 1748 "type": "boolean"
1378 }, 1749 },
1379 "first": { 1750 "first": {
1380 "description": "Optional. Set this to True if this is the fi rst log entry in the operation.", 1751 "description": "Optional. Set this to True if this is the fi rst log entry in the operation.",
1381 "type": "boolean" 1752 "type": "boolean"
1382 }, 1753 },
1383 "id": { 1754 "id": {
1384 "description": "Optional. An arbitrary operation identifier. Log entries with the\nsame identifier are assumed to be part of the same operat ion.", 1755 "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operati on.",
1385 "type": "string" 1756 "type": "string"
1386 } 1757 }
1387 }, 1758 },
1388 "type": "object" 1759 "type": "object"
1389 }, 1760 },
1390 "Empty": { 1761 "Empty": {
1391 "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 `{}`.", 1762 "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:\nservice Fo o {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe J SON representation for Empty is empty JSON object {}.",
1392 "id": "Empty", 1763 "id": "Empty",
1393 "properties": {}, 1764 "properties": {},
1394 "type": "object" 1765 "type": "object"
1395 }, 1766 },
1396 "HttpRequest": { 1767 "HttpRequest": {
1397 "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.", 1768 "description": "A common proto for logging HTTP requests. Only conta ins semantics defined by the HTTP specification. Product-specific logging inform ation MUST be defined in a separate message.",
1398 "id": "HttpRequest", 1769 "id": "HttpRequest",
1399 "properties": { 1770 "properties": {
1400 "cacheLookup": { 1771 "cacheLookup": {
1401 "description": "Whether or not a cache lookup was attempted. ", 1772 "description": "Whether or not a cache lookup was attempted. ",
1402 "type": "boolean" 1773 "type": "boolean"
1403 }, 1774 },
1404 "responseSize": { 1775 "responseSize": {
1405 "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.", 1776 "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.",
1406 "format": "int64", 1777 "format": "int64",
1407 "type": "string" 1778 "type": "string"
1408 }, 1779 },
1409 "status": { 1780 "status": {
1410 "description": "The response code indicating the status of r esponse.\nExamples: 200, 404.", 1781 "description": "The response code indicating the status of r esponse. Examples: 200, 404.",
1411 "format": "int32", 1782 "format": "int32",
1412 "type": "integer" 1783 "type": "integer"
1413 }, 1784 },
1414 "cacheValidatedWithOriginServer": { 1785 "cacheValidatedWithOriginServer": {
1415 "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.", 1786 "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.",
1416 "type": "boolean" 1787 "type": "boolean"
1417 }, 1788 },
1418 "referer": { 1789 "referer": {
1419 "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).", 1790 "description": "The referer URL of the request, as defined i n HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616 -sec14.html).",
1420 "type": "string" 1791 "type": "string"
1421 }, 1792 },
1422 "cacheHit": { 1793 "cacheHit": {
1423 "description": "Whether or not an entity was served from cac he\n(with or without validation).", 1794 "description": "Whether or not an entity was served from cac he (with or without validation).",
1424 "type": "boolean" 1795 "type": "boolean"
1425 }, 1796 },
1426 "requestUrl": { 1797 "requestUrl": {
1427 "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\"`.", 1798 "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://exa mple.com/some/info?color=red\".",
1428 "type": "string" 1799 "type": "string"
1429 }, 1800 },
1430 "latency": { 1801 "latency": {
1431 "description": "The request processing latency on the server , from the time the request was\nreceived until the response was sent.", 1802 "description": "The request processing latency on the server , from the time the request was received until the response was sent.",
1432 "format": "google-duration", 1803 "format": "google-duration",
1433 "type": "string" 1804 "type": "string"
1434 }, 1805 },
1435 "cacheFillBytes": { 1806 "cacheFillBytes": {
1436 "description": "The number of HTTP response bytes inserted i nto cache. Set only when a\ncache fill was attempted.", 1807 "description": "The number of HTTP response bytes inserted i nto cache. Set only when a cache fill was attempted.",
1437 "format": "int64", 1808 "format": "int64",
1438 "type": "string" 1809 "type": "string"
1439 }, 1810 },
1440 "requestMethod": { 1811 "requestMethod": {
1441 "description": "The request method. Examples: `\"GET\"`, `\" HEAD\"`, `\"PUT\"`, `\"POST\"`.", 1812 "description": "The request method. Examples: \"GET\", \"HEA D\", \"PUT\", \"POST\".",
1442 "type": "string" 1813 "type": "string"
1443 }, 1814 },
1444 "remoteIp": { 1815 "remoteIp": {
1445 "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\"`.", 1816 "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E: 8329\".",
1446 "type": "string" 1817 "type": "string"
1447 }, 1818 },
1448 "serverIp": { 1819 "serverIp": {
1449 "description": "The IP address (IPv4 or IPv6) of the origin server that the request was\nsent to.", 1820 "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
1450 "type": "string" 1821 "type": "string"
1451 }, 1822 },
1452 "userAgent": { 1823 "userAgent": {
1453 "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)\" `.", 1824 "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"." ,
1454 "type": "string" 1825 "type": "string"
1455 }, 1826 },
1456 "requestSize": { 1827 "requestSize": {
1457 "description": "The size of the HTTP request message in byte s, including the request\nheaders and the request body.", 1828 "description": "The size of the HTTP request message in byte s, including the request headers and the request body.",
1458 "format": "int64", 1829 "format": "int64",
1459 "type": "string" 1830 "type": "string"
1460 } 1831 }
1832 },
1833 "type": "object"
1834 },
1835 "LogEntrySourceLocation": {
1836 "description": "Additional information about the source code locatio n that produced the log entry.",
1837 "id": "LogEntrySourceLocation",
1838 "properties": {
1839 "function": {
1840 "description": "Optional. Human-readable name of the functio n or method being invoked, with optional context such as the class or package na me. This information may be used in contexts such as the logs viewer, where a fi le and line number are less meaningful. The format can vary by language. For exa mple: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). ",
1841 "type": "string"
1842 },
1843 "file": {
1844 "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
1845 "type": "string"
1846 },
1847 "line": {
1848 "description": "Optional. Line within the source file. 1-bas ed; 0 indicates no line number available.",
1849 "format": "int64",
1850 "type": "string"
1851 }
1461 }, 1852 },
1462 "type": "object" 1853 "type": "object"
1463 }, 1854 },
1464 "RequestLog": { 1855 "RequestLog": {
1465 "description": "Complete log information about a single HTTP request to an App Engine\napplication.", 1856 "description": "Complete log information about a single HTTP request to an App Engine application.",
1466 "id": "RequestLog", 1857 "id": "RequestLog",
1467 "properties": { 1858 "properties": {
1468 "responseSize": { 1859 "responseSize": {
1469 "description": "Size in bytes sent back to client by request .", 1860 "description": "Size in bytes sent back to client by request .",
1470 "format": "int64", 1861 "format": "int64",
1471 "type": "string" 1862 "type": "string"
1472 }, 1863 },
1473 "requestId": { 1864 "requestId": {
1474 "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.", 1865 "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.",
1475 "type": "string" 1866 "type": "string"
1476 }, 1867 },
1477 "first": { 1868 "first": {
1478 "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.", 1869 "description": "Whether this is the first RequestLog entry f or this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
1479 "type": "boolean" 1870 "type": "boolean"
1480 }, 1871 },
1481 "method": { 1872 "method": {
1482 "description": "Request method. Example: `\"GET\"`, `\"HEAD\ "`, `\"PUT\"`, `\"POST\"`, `\"DELETE\"`.", 1873 "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
1483 "type": "string" 1874 "type": "string"
1484 }, 1875 },
1485 "versionId": { 1876 "versionId": {
1486 "description": "Version of the application that handled this request.", 1877 "description": "Version of the application that handled this request.",
1487 "type": "string" 1878 "type": "string"
1488 }, 1879 },
1489 "status": { 1880 "status": {
1490 "description": "HTTP response status code. Example: 200, 404 .", 1881 "description": "HTTP response status code. Example: 200, 404 .",
1491 "format": "int32", 1882 "format": "int32",
1492 "type": "integer" 1883 "type": "integer"
1493 }, 1884 },
1494 "wasLoadingRequest": { 1885 "wasLoadingRequest": {
1495 "description": "Whether this was a loading request for the i nstance.", 1886 "description": "Whether this was a loading request for the i nstance.",
1496 "type": "boolean" 1887 "type": "boolean"
1497 }, 1888 },
1498 "ip": { 1889 "ip": {
1499 "description": "Origin IP address.", 1890 "description": "Origin IP address.",
1500 "type": "string" 1891 "type": "string"
1501 }, 1892 },
1502 "nickname": { 1893 "nickname": {
1503 "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.", 1894 "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via th e App Engine Users API.This field will be populated starting with App Engine 1.9 .21.",
1504 "type": "string" 1895 "type": "string"
1505 }, 1896 },
1506 "taskQueueName": { 1897 "taskQueueName": {
1507 "description": "Queue name of the request, in the case of an offline request.", 1898 "description": "Queue name of the request, in the case of an offline request.",
1508 "type": "string" 1899 "type": "string"
1509 }, 1900 },
1510 "pendingTime": { 1901 "pendingTime": {
1511 "description": "Time this request spent in the pending reque st queue.", 1902 "description": "Time this request spent in the pending reque st queue.",
1512 "format": "google-duration", 1903 "format": "google-duration",
1513 "type": "string" 1904 "type": "string"
1514 }, 1905 },
1515 "instanceIndex": { 1906 "instanceIndex": {
1516 "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.", 1907 "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.",
1517 "format": "int32", 1908 "format": "int32",
1518 "type": "integer" 1909 "type": "integer"
1519 }, 1910 },
1520 "sourceReference": { 1911 "sourceReference": {
1521 "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.", 1912 "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.",
1522 "items": { 1913 "items": {
1523 "$ref": "SourceReference" 1914 "$ref": "SourceReference"
1524 }, 1915 },
1525 "type": "array" 1916 "type": "array"
1526 }, 1917 },
1527 "moduleId": { 1918 "moduleId": {
1528 "description": "Module of the application that handled this request.", 1919 "description": "Module of the application that handled this request.",
1529 "type": "string" 1920 "type": "string"
1530 }, 1921 },
1531 "host": { 1922 "host": {
(...skipping 24 matching lines...) Expand all
1556 "megaCycles": { 1947 "megaCycles": {
1557 "description": "Number of CPU megacycles used to process req uest.", 1948 "description": "Number of CPU megacycles used to process req uest.",
1558 "format": "int64", 1949 "format": "int64",
1559 "type": "string" 1950 "type": "string"
1560 }, 1951 },
1561 "appId": { 1952 "appId": {
1562 "description": "Application that handled this request.", 1953 "description": "Application that handled this request.",
1563 "type": "string" 1954 "type": "string"
1564 }, 1955 },
1565 "traceId": { 1956 "traceId": {
1566 "description": "Cloud Trace identifier for this request.", 1957 "description": "Stackdriver Trace identifier for this reques t.",
1567 "type": "string" 1958 "type": "string"
1568 }, 1959 },
1569 "taskName": { 1960 "taskName": {
1570 "description": "Task name of the request, in the case of an offline request.", 1961 "description": "Task name of the request, in the case of an offline request.",
1571 "type": "string" 1962 "type": "string"
1572 }, 1963 },
1573 "cost": { 1964 "cost": {
1574 "description": "An indication of the relative cost of servin g this request.", 1965 "description": "An indication of the relative cost of servin g this request.",
1575 "format": "double", 1966 "format": "double",
1576 "type": "number" 1967 "type": "number"
1577 }, 1968 },
1578 "instanceId": { 1969 "instanceId": {
1579 "description": "An identifier for the instance that handled the request.", 1970 "description": "An identifier for the instance that handled the request.",
1580 "type": "string" 1971 "type": "string"
1581 }, 1972 },
1582 "startTime": { 1973 "startTime": {
1583 "description": "Time when the request started.", 1974 "description": "Time when the request started.",
1584 "format": "google-datetime", 1975 "format": "google-datetime",
1585 "type": "string" 1976 "type": "string"
1586 }, 1977 },
1587 "appEngineRelease": { 1978 "appEngineRelease": {
1588 "description": "App Engine release version.", 1979 "description": "App Engine release version.",
1589 "type": "string" 1980 "type": "string"
1590 }, 1981 },
1591 "resource": { 1982 "resource": {
1592 "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.", 1983 "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.",
1593 "type": "string" 1984 "type": "string"
1594 }, 1985 },
1595 "httpVersion": { 1986 "httpVersion": {
1596 "description": "HTTP version of request. Example: `\"HTTP/1. 1\"`.", 1987 "description": "HTTP version of request. Example: \"HTTP/1.1 \".",
1597 "type": "string" 1988 "type": "string"
1598 }, 1989 },
1599 "referrer": { 1990 "referrer": {
1600 "description": "Referrer URL of request.", 1991 "description": "Referrer URL of request.",
1601 "type": "string" 1992 "type": "string"
1602 }, 1993 },
1603 "userAgent": { 1994 "userAgent": {
1604 "description": "User agent that made the request.", 1995 "description": "User agent that made the request.",
1605 "type": "string" 1996 "type": "string"
1606 }, 1997 },
1607 "finished": { 1998 "finished": {
1608 "description": "Whether this request is finished or active." , 1999 "description": "Whether this request is finished or active." ,
1609 "type": "boolean" 2000 "type": "boolean"
1610 } 2001 }
1611 }, 2002 },
1612 "type": "object" 2003 "type": "object"
1613 }, 2004 },
1614 "WriteLogEntriesResponse": { 2005 "WriteLogEntriesResponse": {
1615 "description": "Result returned from WriteLogEntries.\nempty", 2006 "description": "Result returned from WriteLogEntries. empty",
1616 "id": "WriteLogEntriesResponse", 2007 "id": "WriteLogEntriesResponse",
1617 "properties": {}, 2008 "properties": {},
1618 "type": "object" 2009 "type": "object"
1619 }, 2010 },
1620 "ListLogEntriesRequest": { 2011 "ListLogEntriesRequest": {
1621 "description": "The parameters to `ListLogEntries`.", 2012 "description": "The parameters to ListLogEntries.",
1622 "id": "ListLogEntriesRequest", 2013 "id": "ListLogEntriesRequest",
1623 "properties": { 2014 "properties": {
1624 "filter": { 2015 "filter": {
1625 "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.", 2016 "description": "Optional. A filter that chooses which log en tries to return. See Advanced Logs Filters. Only log entries that match the filt er are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource _names will cause the filter to return no results. The maximum length of the fil ter is 20000 characters.",
1626 "type": "string" 2017 "type": "string"
1627 }, 2018 },
1628 "projectIds": { 2019 "projectIds": {
1629 "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.", 2020 "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entrie s. Example: \"my-project-1A\". If present, these project identifiers are convert ed to resource name format and added to the list of resources in resource_names. ",
1630 "items": { 2021 "items": {
1631 "type": "string" 2022 "type": "string"
1632 }, 2023 },
1633 "type": "array" 2024 "type": "array"
1634 }, 2025 },
1635 "resourceNames": { 2026 "resourceNames": {
1636 "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.", 2027 "description": "Required. Names of one or more resources fro m which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[OR GANIZATION_ID]\"\nProjects listed in the project_ids field are added to this lis t.",
1637 "items": { 2028 "items": {
1638 "type": "string" 2029 "type": "string"
1639 }, 2030 },
1640 "type": "array" 2031 "type": "array"
1641 }, 2032 },
1642 "pageSize": { 2033 "pageSize": {
1643 "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.", 2034 "description": "Optional. The maximum number of results to r eturn from this request. Non-positive values are ignored. The presence of nextPa geToken in the response indicates that more results might be available.",
1644 "format": "int32", 2035 "format": "int32",
1645 "type": "integer" 2036 "type": "integer"
1646 }, 2037 },
1647 "orderBy": { 2038 "orderBy": {
1648 "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`.", 2039 "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"times tamp desc\". The first option returns entries in order of increasing values of L ogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are retu rned in order of LogEntry.insertId.",
1649 "type": "string" 2040 "type": "string"
1650 }, 2041 },
1651 "pageToken": { 2042 "pageToken": {
1652 "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.", 2043 "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method pa rameters should be identical to those in the previous call.",
1653 "type": "string" 2044 "type": "string"
1654 } 2045 }
1655 }, 2046 },
1656 "type": "object" 2047 "type": "object"
1657 } 2048 }
1658 }, 2049 },
1659 "servicePath": "", 2050 "servicePath": "",
1660 "title": "Stackdriver Logging API", 2051 "title": "Stackdriver Logging API",
1661 "version": "v2" 2052 "version": "v2"
1662 } 2053 }
OLDNEW
« no previous file with comments | « discovery/googleapis/licensing__v1.json ('k') | discovery/googleapis/mirror__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698