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

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months 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/cloudtrace__v1.json ('k') | discovery/googleapis/compute__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/trace.append": {
6 "description": "Write Trace data for a project or applicatio n"
7 },
5 "https://www.googleapis.com/auth/cloud-platform": { 8 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 9 "description": "View and manage your data across Google Clou d Platform services"
7 }, 10 },
8 "https://www.googleapis.com/auth/trace.readonly": { 11 "https://www.googleapis.com/auth/trace.readonly": {
9 "description": "Read Trace data for a project or application " 12 "description": "Read Trace data for a project or application "
10 },
11 "https://www.googleapis.com/auth/trace.append": {
12 "description": "Write Trace data for a project or applicatio n"
13 } 13 }
14 } 14 }
15 } 15 }
16 }, 16 },
17 "basePath": "", 17 "basePath": "",
18 "baseUrl": "https://cloudtrace.googleapis.com/", 18 "baseUrl": "https://cloudtrace.googleapis.com/",
19 "batchPath": "batch", 19 "batchPath": "batch",
20 "canonicalName": "Cloud Trace", 20 "canonicalName": "Cloud Trace",
21 "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from o ther applications can be written to Stackdriver Trace for display, reporting, an d analysis.\n", 21 "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from o ther applications can be written to Stackdriver Trace for display, reporting, an d analysis.\n",
22 "discoveryVersion": "v1", 22 "discoveryVersion": "v1",
23 "documentationLink": "https://cloud.google.com/trace", 23 "documentationLink": "https://cloud.google.com/trace",
24 "icons": { 24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", 25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" 26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 }, 27 },
28 "id": "cloudtrace:v2", 28 "id": "cloudtrace:v2",
29 "kind": "discovery#restDescription", 29 "kind": "discovery#restDescription",
30 "name": "cloudtrace", 30 "name": "cloudtrace",
31 "ownerDomain": "google.com", 31 "ownerDomain": "google.com",
32 "ownerName": "Google", 32 "ownerName": "Google",
33 "parameters": { 33 "parameters": {
34 "upload_protocol": {
35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
36 "location": "query",
37 "type": "string"
38 },
39 "prettyPrint": {
40 "default": "true",
41 "description": "Returns response with indentations and line breaks." ,
42 "location": "query",
43 "type": "boolean"
44 },
45 "uploadType": { 34 "uploadType": {
46 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 35 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
47 "location": "query", 36 "location": "query",
48 "type": "string" 37 "type": "string"
49 }, 38 },
50 "fields": { 39 "fields": {
51 "description": "Selector specifying which fields to include in a par tial response.", 40 "description": "Selector specifying which fields to include in a par tial response.",
52 "location": "query", 41 "location": "query",
53 "type": "string" 42 "type": "string"
54 }, 43 },
(...skipping 24 matching lines...) Expand all
79 "proto" 68 "proto"
80 ], 69 ],
81 "enumDescriptions": [ 70 "enumDescriptions": [
82 "Responses with Content-Type of application/json", 71 "Responses with Content-Type of application/json",
83 "Media download with context-dependent Content-Type", 72 "Media download with context-dependent Content-Type",
84 "Responses with Content-Type of application/x-protobuf" 73 "Responses with Content-Type of application/x-protobuf"
85 ], 74 ],
86 "location": "query", 75 "location": "query",
87 "type": "string" 76 "type": "string"
88 }, 77 },
78 "key": {
79 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
80 "location": "query",
81 "type": "string"
82 },
89 "access_token": { 83 "access_token": {
90 "description": "OAuth access token.", 84 "description": "OAuth access token.",
91 "location": "query", 85 "location": "query",
92 "type": "string" 86 "type": "string"
93 }, 87 },
94 "key": {
95 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
96 "location": "query",
97 "type": "string"
98 },
99 "quotaUser": { 88 "quotaUser": {
100 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 89 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
101 "location": "query", 90 "location": "query",
102 "type": "string" 91 "type": "string"
103 }, 92 },
104 "pp": { 93 "pp": {
105 "default": "true", 94 "default": "true",
106 "description": "Pretty-print response.", 95 "description": "Pretty-print response.",
107 "location": "query", 96 "location": "query",
108 "type": "boolean" 97 "type": "boolean"
109 }, 98 },
110 "bearer_token": { 99 "bearer_token": {
111 "description": "OAuth bearer token.", 100 "description": "OAuth bearer token.",
112 "location": "query", 101 "location": "query",
113 "type": "string" 102 "type": "string"
114 }, 103 },
115 "oauth_token": { 104 "oauth_token": {
116 "description": "OAuth 2.0 token for the current user.", 105 "description": "OAuth 2.0 token for the current user.",
117 "location": "query", 106 "location": "query",
118 "type": "string" 107 "type": "string"
108 },
109 "upload_protocol": {
110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
111 "location": "query",
112 "type": "string"
113 },
114 "prettyPrint": {
115 "default": "true",
116 "description": "Returns response with indentations and line breaks." ,
117 "location": "query",
118 "type": "boolean"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "resources": { 124 "resources": {
125 "traces": { 125 "traces": {
126 "methods": { 126 "methods": {
127 "list": { 127 "list": {
128 "description": "Returns of a list of traces that mat ch the specified filter conditions.", 128 "description": "Returns of a list of traces that mat ch the specified filter conditions.",
129 "httpMethod": "GET", 129 "httpMethod": "GET",
130 "id": "cloudtrace.projects.traces.list", 130 "id": "cloudtrace.projects.traces.list",
131 "parameterOrder": [ 131 "parameterOrder": [
132 "parent" 132 "parent"
133 ], 133 ],
134 "parameters": { 134 "parameters": {
135 "orderBy": {
136 "description": "Optional. A single field use d to sort the returned traces.\nOnly the following field names can be used:\n\n* `trace_id`: the trace's ID field\n* `name`: the root span's resource name\ n* `duration`: the difference between the root span's start time and end time\ n* `start`: the start time of the root span\n\nSorting is in ascending order unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).",
137 "location": "query",
138 "type": "string"
139 },
135 "filter": { 140 "filter": {
136 "description": "Opional. Return only traces that match this\n[trace filter](/trace/docs/trace-filters). Example:\n\n \"la bel:/http/url root:/_ah/background my_label:17\"", 141 "description": "Opional. Return only traces that match this\n[trace filter](/trace/docs/trace-filters). Example:\n\n \"la bel:/http/url root:/_ah/background my_label:17\"",
137 "location": "query", 142 "location": "query",
138 "type": "string" 143 "type": "string"
139 }, 144 },
140 "endTime": { 145 "endTime": {
141 "description": "Optional. Do not return trac es whose start time is later than this time.", 146 "description": "Optional. Do not return trac es whose start time is later than this time.",
142 "format": "google-datetime", 147 "format": "google-datetime",
143 "location": "query", 148 "location": "query",
144 "type": "string" 149 "type": "string"
145 }, 150 },
151 "pageToken": {
152 "description": "Optional. If present, then r etrieve the next batch of results from the\npreceding call to this method. `pag e_token` must be the value of\n`next_page_token` from the previous response. Th e values of other method\nparameters should be identical to those in the previou s call.",
153 "location": "query",
154 "type": "string"
155 },
146 "startTime": { 156 "startTime": {
147 "description": "Optional. Do not return trac es whose end time is earlier than this time.", 157 "description": "Optional. Do not return trac es whose end time is earlier than this time.",
148 "format": "google-datetime", 158 "format": "google-datetime",
149 "location": "query", 159 "location": "query",
150 "type": "string" 160 "type": "string"
151 }, 161 },
152 "pageToken": {
153 "description": "Optional. If present, then r etrieve the next batch of results from the\npreceding call to this method. `pag e_token` must be the value of\n`next_page_token` from the previous response. Th e values of other method\nparameters should be identical to those in the previou s call.",
154 "location": "query",
155 "type": "string"
156 },
157 "pageSize": { 162 "pageSize": {
158 "description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The p resence of `next_page_token` in the\nresponse indicates that more results might be available, even if fewer than\nthe maximum number of results is returned by t his request.", 163 "description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The p resence of `next_page_token` in the\nresponse indicates that more results might be available, even if fewer than\nthe maximum number of results is returned by t his request.",
159 "format": "int32", 164 "format": "int32",
160 "location": "query", 165 "location": "query",
161 "type": "integer" 166 "type": "integer"
162 }, 167 },
163 "parent": { 168 "parent": {
164 "description": "Required. The project where the trace data is stored. The format\nis `projects/PROJECT_ID`.", 169 "description": "Required. The project where the trace data is stored. The format\nis `projects/PROJECT_ID`.",
165 "location": "path", 170 "location": "path",
166 "pattern": "^projects/[^/]+$", 171 "pattern": "^projects/[^/]+$",
167 "required": true, 172 "required": true,
168 "type": "string" 173 "type": "string"
169 },
170 "orderBy": {
171 "description": "Optional. A single field use d to sort the returned traces.\nOnly the following field names can be used:\n\n* `trace_id`: the trace's ID field\n* `name`: the root span's resource name\ n* `duration`: the difference between the root span's start time and end time\ n* `start`: the start time of the root span\n\nSorting is in ascending order unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).",
172 "location": "query",
173 "type": "string"
174 } 174 }
175 }, 175 },
176 "path": "v2/{+parent}/traces", 176 "path": "v2/{+parent}/traces",
177 "response": { 177 "response": {
178 "$ref": "ListTracesResponse" 178 "$ref": "ListTracesResponse"
179 }, 179 },
180 "scopes": [ 180 "scopes": [
181 "https://www.googleapis.com/auth/cloud-platform" , 181 "https://www.googleapis.com/auth/cloud-platform" ,
182 "https://www.googleapis.com/auth/trace.readonly" 182 "https://www.googleapis.com/auth/trace.readonly"
183 ] 183 ]
(...skipping 27 matching lines...) Expand all
211 ] 211 ]
212 }, 212 },
213 "listSpans": { 213 "listSpans": {
214 "description": "Returns a list of spans within a tra ce.", 214 "description": "Returns a list of spans within a tra ce.",
215 "httpMethod": "GET", 215 "httpMethod": "GET",
216 "id": "cloudtrace.projects.traces.listSpans", 216 "id": "cloudtrace.projects.traces.listSpans",
217 "parameterOrder": [ 217 "parameterOrder": [
218 "parent" 218 "parent"
219 ], 219 ],
220 "parameters": { 220 "parameters": {
221 "pageToken": {
222 "description": "Optional. If present, then r etrieve the next batch of results from the\npreceding call to this method. `page _token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
223 "location": "query",
224 "type": "string"
225 },
221 "parent": { 226 "parent": {
222 "description": "Required: The resource name of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/t races/TRACE_ID`.", 227 "description": "Required: The resource name of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/t races/TRACE_ID`.",
223 "location": "path", 228 "location": "path",
224 "pattern": "^projects/[^/]+/traces/[^/]+$", 229 "pattern": "^projects/[^/]+/traces/[^/]+$",
225 "required": true, 230 "required": true,
226 "type": "string" 231 "type": "string"
227 },
228 "pageToken": {
229 "description": "Optional. If present, then r etrieve the next batch of results from the\npreceding call to this method. `page _token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
230 "location": "query",
231 "type": "string"
232 } 232 }
233 }, 233 },
234 "path": "v2/{+parent}:listSpans", 234 "path": "v2/{+parent}:listSpans",
235 "response": { 235 "response": {
236 "$ref": "ListSpansResponse" 236 "$ref": "ListSpansResponse"
237 }, 237 },
238 "scopes": [ 238 "scopes": [
239 "https://www.googleapis.com/auth/cloud-platform" , 239 "https://www.googleapis.com/auth/cloud-platform" ,
240 "https://www.googleapis.com/auth/trace.readonly" 240 "https://www.googleapis.com/auth/trace.readonly"
241 ] 241 ]
(...skipping 30 matching lines...) Expand all
272 "https://www.googleapis.com/auth/trace.a ppend" 272 "https://www.googleapis.com/auth/trace.a ppend"
273 ] 273 ]
274 } 274 }
275 } 275 }
276 } 276 }
277 } 277 }
278 } 278 }
279 } 279 }
280 } 280 }
281 }, 281 },
282 "revision": "20170802", 282 "revision": "20170905",
283 "rootUrl": "https://cloudtrace.googleapis.com/", 283 "rootUrl": "https://cloudtrace.googleapis.com/",
284 "schemas": { 284 "schemas": {
285 "TimeEvent": {
286 "description": "A time-stamped annotation or network event in the Sp an.",
287 "id": "TimeEvent",
288 "properties": {
289 "time": {
290 "description": "The timestamp indicating the time the event occurred.",
291 "format": "google-datetime",
292 "type": "string"
293 },
294 "networkEvent": {
295 "$ref": "NetworkEvent",
296 "description": "An event describing an RPC message sent/rece ived on the network."
297 },
298 "annotation": {
299 "$ref": "Annotation",
300 "description": "One or more key:value pairs."
301 }
302 },
303 "type": "object"
304 },
305 "NetworkEvent": {
306 "description": "An event describing an RPC message sent or received on the network.",
307 "id": "NetworkEvent",
308 "properties": {
309 "time": {
310 "description": "For sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the l ast bit was\nreceived.",
311 "format": "google-datetime",
312 "type": "string"
313 },
314 "uncompressedMessageSize": {
315 "description": "The number of uncompressed bytes sent or rec eived.",
316 "format": "uint64",
317 "type": "string"
318 },
319 "type": {
320 "description": "Type of NetworkEvent. Indicates whether the RPC message was sent or\nreceived.",
321 "enum": [
322 "TYPE_UNSPECIFIED",
323 "SENT",
324 "RECV"
325 ],
326 "enumDescriptions": [
327 "Unknown event type.",
328 "Indicates a sent RPC message.",
329 "Indicates a received RPC message."
330 ],
331 "type": "string"
332 },
333 "messageId": {
334 "description": "An identifier for the message, which must be unique in this span.",
335 "format": "uint64",
336 "type": "string"
337 },
338 "compressedMessageSize": {
339 "description": "The number of compressed bytes sent or recei ved.",
340 "format": "uint64",
341 "type": "string"
342 }
343 },
344 "type": "object"
345 },
346 "ListSpansResponse": {
347 "description": "The response message for the `ListSpans` method.",
348 "id": "ListSpansResponse",
349 "properties": {
350 "spans": {
351 "description": "The requested spans, if there are any in the specified trace.",
352 "items": {
353 "$ref": "Span"
354 },
355 "type": "array"
356 },
357 "nextPageToken": {
358 "description": "If defined, indicates that there might be mo re spans that match the\nrequest. Pass this as the value of `pageToken` in a sub sequent request to\nretrieve additional spans.",
359 "type": "string"
360 }
361 },
362 "type": "object"
363 },
285 "StackFrame": { 364 "StackFrame": {
286 "description": "Represents a single stack frame in a stack trace.", 365 "description": "Represents a single stack frame in a stack trace.",
287 "id": "StackFrame", 366 "id": "StackFrame",
288 "properties": { 367 "properties": {
289 "functionName": { 368 "functionName": {
290 "$ref": "TruncatableString", 369 "$ref": "TruncatableString",
291 "description": "The fully-qualified name that uniquely ident ifies the function or\nmethod that is active in this frame (up to 1024 bytes)." 370 "description": "The fully-qualified name that uniquely ident ifies the function or\nmethod that is active in this frame (up to 1024 bytes)."
292 }, 371 },
293 "lineNumber": { 372 "lineNumber": {
294 "description": "The line number in `file_name` where the fun ction call appears.", 373 "description": "The line number in `file_name` where the fun ction call appears.",
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
349 "description": "`SPAN_ID` identifies a span within a trace." , 428 "description": "`SPAN_ID` identifies a span within a trace." ,
350 "type": "string" 429 "type": "string"
351 } 430 }
352 }, 431 },
353 "type": "object" 432 "type": "object"
354 }, 433 },
355 "Annotation": { 434 "Annotation": {
356 "description": "Text annotation with a set of attributes.", 435 "description": "Text annotation with a set of attributes.",
357 "id": "Annotation", 436 "id": "Annotation",
358 "properties": { 437 "properties": {
438 "description": {
439 "$ref": "TruncatableString",
440 "description": "A user-supplied message describing the event . The maximum length for\nthe description is 256 bytes."
441 },
359 "attributes": { 442 "attributes": {
360 "$ref": "Attributes", 443 "$ref": "Attributes",
361 "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation." 444 "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation."
362 },
363 "description": {
364 "$ref": "TruncatableString",
365 "description": "A user-supplied message describing the event . The maximum length for\nthe description is 256 bytes."
366 } 445 }
367 }, 446 },
368 "type": "object" 447 "type": "object"
369 }, 448 },
370 "StackFrames": { 449 "StackFrames": {
371 "description": "A collection of stack frames, which can be truncated .", 450 "description": "A collection of stack frames, which can be truncated .",
372 "id": "StackFrames", 451 "id": "StackFrames",
373 "properties": { 452 "properties": {
374 "droppedFramesCount": {
375 "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack f rames were dropped.",
376 "format": "int32",
377 "type": "integer"
378 },
379 "frame": { 453 "frame": {
380 "description": "Stack frames in this call stack.", 454 "description": "Stack frames in this call stack.",
381 "items": { 455 "items": {
382 "$ref": "StackFrame" 456 "$ref": "StackFrame"
383 }, 457 },
384 "type": "array" 458 "type": "array"
459 },
460 "droppedFramesCount": {
461 "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack f rames were dropped.",
462 "format": "int32",
463 "type": "integer"
385 } 464 }
386 }, 465 },
387 "type": "object" 466 "type": "object"
388 }, 467 },
389 "Trace": { 468 "Trace": {
390 "description": "A trace describes how long it takes for an applicati on to perform some\noperations. It consists of a set of spans, each representing \nan operation and including time information and operation details.", 469 "description": "A trace describes how long it takes for an applicati on to perform some\noperations. It consists of a set of spans, each representing \nan operation and including time information and operation details.",
391 "id": "Trace", 470 "id": "Trace",
392 "properties": { 471 "properties": {
393 "name": { 472 "name": {
394 "description": "The resource name of the trace in the follow ing format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier for a trace within a project.\nThe ID is assigned when the trace is created.", 473 "description": "The resource name of the trace in the follow ing format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier for a trace within a project.\nThe ID is assigned when the trace is created.",
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
433 "$ref": "TruncatableString", 512 "$ref": "TruncatableString",
434 "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)." 513 "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
435 } 514 }
436 }, 515 },
437 "type": "object" 516 "type": "object"
438 }, 517 },
439 "Status": { 518 "Status": {
440 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 519 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
441 "id": "Status", 520 "id": "Status",
442 "properties": { 521 "properties": {
522 "code": {
523 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
524 "format": "int32",
525 "type": "integer"
526 },
527 "message": {
528 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
529 "type": "string"
530 },
443 "details": { 531 "details": {
444 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.", 532 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
445 "items": { 533 "items": {
446 "additionalProperties": { 534 "additionalProperties": {
447 "description": "Properties of the object. Contains f ield @type with type URL.", 535 "description": "Properties of the object. Contains f ield @type with type URL.",
448 "type": "any" 536 "type": "any"
449 }, 537 },
450 "type": "object" 538 "type": "object"
451 }, 539 },
452 "type": "array" 540 "type": "array"
453 },
454 "code": {
455 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
456 "format": "int32",
457 "type": "integer"
458 },
459 "message": {
460 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
461 "type": "string"
462 } 541 }
463 }, 542 },
464 "type": "object" 543 "type": "object"
465 }, 544 },
466 "BatchWriteSpansRequest": { 545 "BatchWriteSpansRequest": {
467 "description": "The request message for the `BatchWriteSpans` method .", 546 "description": "The request message for the `BatchWriteSpans` method .",
468 "id": "BatchWriteSpansRequest", 547 "id": "BatchWriteSpansRequest",
469 "properties": { 548 "properties": {
470 "spans": { 549 "spans": {
471 "description": "A collection of spans.", 550 "description": "A collection of spans.",
472 "items": { 551 "items": {
473 "$ref": "Span" 552 "$ref": "Span"
474 }, 553 },
475 "type": "array" 554 "type": "array"
476 } 555 }
477 }, 556 },
478 "type": "object" 557 "type": "object"
479 }, 558 },
480 "Empty": { 559 "Empty": {
481 "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 `{}`.", 560 "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 `{}`.",
482 "id": "Empty", 561 "id": "Empty",
483 "properties": {}, 562 "properties": {},
484 "type": "object" 563 "type": "object"
485 }, 564 },
486 "ListTracesResponse": {
487 "description": "The response message for the `ListTraces` method.",
488 "id": "ListTracesResponse",
489 "properties": {
490 "nextPageToken": {
491 "description": "If there might be more results than those ap pearing in this response, then\n`next_page_token` is included. To get the next set of results, call this\nmethod again using the value of `next_page_token` as `page_token`.",
492 "type": "string"
493 },
494 "traces": {
495 "description": "List of trace records returned.",
496 "items": {
497 "$ref": "Trace"
498 },
499 "type": "array"
500 }
501 },
502 "type": "object"
503 },
504 "Span": { 565 "Span": {
505 "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\ nthat describes the end-to-end latency, and one or more subspans for\nits sub-op erations. A trace can also contain multiple root spans,\nor none at all. Spans d o not need to be contiguous—there may be\ngaps or overlaps between spans i n a trace.", 566 "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\ nthat describes the end-to-end latency, and one or more subspans for\nits sub-op erations. A trace can also contain multiple root spans,\nor none at all. Spans d o not need to be contiguous—there may be\ngaps or overlaps between spans i n a trace.",
506 "id": "Span", 567 "id": "Span",
507 "properties": { 568 "properties": {
508 "sameProcessAsParentSpan": { 569 "sameProcessAsParentSpan": {
509 "description": "A highly recommended but not required flag t hat identifies when a trace\ncrosses a process boundary. True when the parent_sp an belongs to the\nsame process as the current span.", 570 "description": "A highly recommended but not required flag t hat identifies when a trace\ncrosses a process boundary. True when the parent_sp an belongs to the\nsame process as the current span.",
510 "type": "boolean" 571 "type": "boolean"
511 }, 572 },
512 "status": { 573 "status": {
513 "$ref": "Status", 574 "$ref": "Status",
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
556 "type": "string" 617 "type": "string"
557 }, 618 },
558 "childSpanCount": { 619 "childSpanCount": {
559 "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect m issing child spans.", 620 "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect m issing child spans.",
560 "format": "uint32", 621 "format": "uint32",
561 "type": "integer" 622 "type": "integer"
562 } 623 }
563 }, 624 },
564 "type": "object" 625 "type": "object"
565 }, 626 },
627 "ListTracesResponse": {
628 "description": "The response message for the `ListTraces` method.",
629 "id": "ListTracesResponse",
630 "properties": {
631 "nextPageToken": {
632 "description": "If there might be more results than those ap pearing in this response, then\n`next_page_token` is included. To get the next set of results, call this\nmethod again using the value of `next_page_token` as `page_token`.",
633 "type": "string"
634 },
635 "traces": {
636 "description": "List of trace records returned.",
637 "items": {
638 "$ref": "Trace"
639 },
640 "type": "array"
641 }
642 },
643 "type": "object"
644 },
566 "AttributeValue": { 645 "AttributeValue": {
567 "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` a ttribute.", 646 "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` a ttribute.",
568 "id": "AttributeValue", 647 "id": "AttributeValue",
569 "properties": { 648 "properties": {
570 "intValue": {
571 "description": "A 64-bit signed integer.",
572 "format": "int64",
573 "type": "string"
574 },
575 "boolValue": { 649 "boolValue": {
576 "description": "A Boolean value represented by `true` or `fa lse`.", 650 "description": "A Boolean value represented by `true` or `fa lse`.",
577 "type": "boolean" 651 "type": "boolean"
578 }, 652 },
579 "stringValue": { 653 "stringValue": {
580 "$ref": "TruncatableString", 654 "$ref": "TruncatableString",
581 "description": "A string up to 256 bytes long." 655 "description": "A string up to 256 bytes long."
656 },
657 "intValue": {
658 "description": "A 64-bit signed integer.",
659 "format": "int64",
660 "type": "string"
582 } 661 }
583 }, 662 },
584 "type": "object" 663 "type": "object"
585 }, 664 },
586 "Attributes": { 665 "Attributes": {
587 "description": "A set of attributes, each in the format `[KEY]:[VALU E]`.", 666 "description": "A set of attributes, each in the format `[KEY]:[VALU E]`.",
588 "id": "Attributes", 667 "id": "Attributes",
589 "properties": { 668 "properties": {
669 "droppedAttributesCount": {
670 "description": "The number of attributes that were discarded . Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
671 "format": "int32",
672 "type": "integer"
673 },
590 "attributeMap": { 674 "attributeMap": {
591 "additionalProperties": { 675 "additionalProperties": {
592 "$ref": "AttributeValue" 676 "$ref": "AttributeValue"
593 }, 677 },
594 "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an inte ger, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_ id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes \": 300\n \"abc.com/myattribute\": true", 678 "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an inte ger, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_ id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes \": 300\n \"abc.com/myattribute\": true",
595 "type": "object" 679 "type": "object"
596 },
597 "droppedAttributesCount": {
598 "description": "The number of attributes that were discarded . Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
599 "format": "int32",
600 "type": "integer"
601 } 680 }
602 }, 681 },
603 "type": "object" 682 "type": "object"
604 }, 683 },
605 "Links": { 684 "Links": {
606 "description": "A collection of links, which are references from thi s span to a span\nin the same or different trace.", 685 "description": "A collection of links, which are references from thi s span to a span\nin the same or different trace.",
607 "id": "Links", 686 "id": "Links",
608 "properties": { 687 "properties": {
609 "link": { 688 "link": {
610 "description": "A collection of links.", 689 "description": "A collection of links.",
611 "items": { 690 "items": {
612 "$ref": "Link" 691 "$ref": "Link"
613 }, 692 },
614 "type": "array" 693 "type": "array"
615 }, 694 },
616 "droppedLinksCount": { 695 "droppedLinksCount": {
617 "description": "The number of dropped links after the maximu m size was enforced. If\nthis value is 0, then no links were dropped.", 696 "description": "The number of dropped links after the maximu m size was enforced. If\nthis value is 0, then no links were dropped.",
618 "format": "int32", 697 "format": "int32",
619 "type": "integer" 698 "type": "integer"
620 } 699 }
621 }, 700 },
622 "type": "object" 701 "type": "object"
623 }, 702 },
703 "TruncatableString": {
704 "description": "Represents a string that might be shortened to a spe cified length.",
705 "id": "TruncatableString",
706 "properties": {
707 "truncatedByteCount": {
708 "description": "The number of bytes removed from the origina l string. If this\nvalue is 0, then the string was not shortened.",
709 "format": "int32",
710 "type": "integer"
711 },
712 "value": {
713 "description": "The shortened string. For example, if the or iginal string was 500\nbytes long and the limit of the string was 128 bytes, the n this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntr uncation always happens on the character boundary, to ensure that\ntruncated str ing is still valid UTF8. In case of multi-byte characters,\nsize of truncated st ring can be less than truncation limit.",
714 "type": "string"
715 }
716 },
717 "type": "object"
718 },
624 "StackTrace": { 719 "StackTrace": {
625 "description": "A call stack appearing in a trace.", 720 "description": "A call stack appearing in a trace.",
626 "id": "StackTrace", 721 "id": "StackTrace",
627 "properties": { 722 "properties": {
628 "stackFrames": {
629 "$ref": "StackFrames",
630 "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
631 },
632 "stackTraceHashId": { 723 "stackTraceHashId": {
633 "description": "The hash ID is used to conserve network band width for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSu bsequent spans within the same request can refer\nto that stack trace by only se tting `stackTraceHashId`.", 724 "description": "The hash ID is used to conserve network band width for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSu bsequent spans within the same request can refer\nto that stack trace by only se tting `stackTraceHashId`.",
634 "format": "uint64", 725 "format": "uint64",
635 "type": "string" 726 "type": "string"
727 },
728 "stackFrames": {
729 "$ref": "StackFrames",
730 "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
636 } 731 }
637 }, 732 },
638 "type": "object" 733 "type": "object"
639 },
640 "TruncatableString": {
641 "description": "Represents a string that might be shortened to a spe cified length.",
642 "id": "TruncatableString",
643 "properties": {
644 "value": {
645 "description": "The shortened string. For example, if the or iginal string was 500\nbytes long and the limit of the string was 128 bytes, the n this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntr uncation always happens on the character boundary, to ensure that\ntruncated str ing is still valid UTF8. In case of multi-byte characters,\nsize of truncated st ring can be less than truncation limit.",
646 "type": "string"
647 },
648 "truncatedByteCount": {
649 "description": "The number of bytes removed from the origina l string. If this\nvalue is 0, then the string was not shortened.",
650 "format": "int32",
651 "type": "integer"
652 }
653 },
654 "type": "object"
655 },
656 "TimeEvent": {
657 "description": "A time-stamped annotation or network event in the Sp an.",
658 "id": "TimeEvent",
659 "properties": {
660 "time": {
661 "description": "The timestamp indicating the time the event occurred.",
662 "format": "google-datetime",
663 "type": "string"
664 },
665 "networkEvent": {
666 "$ref": "NetworkEvent",
667 "description": "An event describing an RPC message sent/rece ived on the network."
668 },
669 "annotation": {
670 "$ref": "Annotation",
671 "description": "One or more key:value pairs."
672 }
673 },
674 "type": "object"
675 },
676 "NetworkEvent": {
677 "description": "An event describing an RPC message sent or received on the network.",
678 "id": "NetworkEvent",
679 "properties": {
680 "time": {
681 "description": "For sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the l ast bit was\nreceived.",
682 "format": "google-datetime",
683 "type": "string"
684 },
685 "type": {
686 "description": "Type of NetworkEvent. Indicates whether the RPC message was sent or\nreceived.",
687 "enum": [
688 "TYPE_UNSPECIFIED",
689 "SENT",
690 "RECV"
691 ],
692 "enumDescriptions": [
693 "Unknown event type.",
694 "Indicates a sent RPC message.",
695 "Indicates a received RPC message."
696 ],
697 "type": "string"
698 },
699 "messageId": {
700 "description": "An identifier for the message, which must be unique in this span.",
701 "format": "uint64",
702 "type": "string"
703 },
704 "messageSize": {
705 "description": "The number of bytes sent or received.",
706 "format": "uint64",
707 "type": "string"
708 }
709 },
710 "type": "object"
711 },
712 "ListSpansResponse": {
713 "description": "The response message for the `ListSpans` method.",
714 "id": "ListSpansResponse",
715 "properties": {
716 "nextPageToken": {
717 "description": "If defined, indicates that there might be mo re spans that match the\nrequest. Pass this as the value of `pageToken` in a sub sequent request to\nretrieve additional spans.",
718 "type": "string"
719 },
720 "spans": {
721 "description": "The requested spans, if there are any in the specified trace.",
722 "items": {
723 "$ref": "Span"
724 },
725 "type": "array"
726 }
727 },
728 "type": "object"
729 } 734 }
730 }, 735 },
731 "servicePath": "", 736 "servicePath": "",
732 "title": "Stackdriver Trace API", 737 "title": "Stackdriver Trace API",
733 "version": "v2" 738 "version": "v2"
734 } 739 }
OLDNEW
« no previous file with comments | « discovery/googleapis/cloudtrace__v1.json ('k') | discovery/googleapis/compute__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698