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

Side by Side Diff: discovery/googleapis_beta/speech__v1beta1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 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
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 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://speech.googleapis.com/", 12 "baseUrl": "https://speech.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "Speech", 14 "canonicalName": "Speech",
15 "description": "Converts audio to text by applying powerful neural network m odels.", 15 "description": "Converts audio to text by applying powerful neural network m odels.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/speech/", 17 "documentationLink": "https://cloud.google.com/speech/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "speech:v1beta1", 22 "id": "speech:v1beta1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "speech", 24 "name": "speech",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "quotaUser": {
29 "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.",
30 "location": "query",
31 "type": "string"
32 },
33 "pp": {
34 "default": "true",
35 "description": "Pretty-print response.",
36 "location": "query",
37 "type": "boolean"
38 },
39 "oauth_token": {
40 "description": "OAuth 2.0 token for the current user.",
41 "location": "query",
42 "type": "string"
43 },
44 "bearer_token": {
45 "description": "OAuth bearer token.",
46 "location": "query",
47 "type": "string"
48 },
49 "upload_protocol": { 28 "upload_protocol": {
50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
51 "location": "query", 30 "location": "query",
52 "type": "string" 31 "type": "string"
53 }, 32 },
54 "prettyPrint": { 33 "prettyPrint": {
55 "default": "true", 34 "default": "true",
56 "description": "Returns response with indentations and line breaks." , 35 "description": "Returns response with indentations and line breaks." ,
57 "location": "query", 36 "location": "query",
58 "type": "boolean" 37 "type": "boolean"
59 }, 38 },
39 "uploadType": {
40 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
41 "location": "query",
42 "type": "string"
43 },
60 "fields": { 44 "fields": {
61 "description": "Selector specifying which fields to include in a par tial response.", 45 "description": "Selector specifying which fields to include in a par tial response.",
62 "location": "query", 46 "location": "query",
63 "type": "string" 47 "type": "string"
64 }, 48 },
65 "uploadType": { 49 "callback": {
66 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 50 "description": "JSONP",
67 "location": "query", 51 "location": "query",
68 "type": "string" 52 "type": "string"
69 }, 53 },
70 "$.xgafv": { 54 "$.xgafv": {
71 "description": "V1 error format.", 55 "description": "V1 error format.",
72 "enum": [ 56 "enum": [
73 "1", 57 "1",
74 "2" 58 "2"
75 ], 59 ],
76 "enumDescriptions": [ 60 "enumDescriptions": [
77 "v1 error format", 61 "v1 error format",
78 "v2 error format" 62 "v2 error format"
79 ], 63 ],
80 "location": "query", 64 "location": "query",
81 "type": "string" 65 "type": "string"
82 }, 66 },
83 "callback": {
84 "description": "JSONP",
85 "location": "query",
86 "type": "string"
87 },
88 "alt": { 67 "alt": {
89 "default": "json", 68 "default": "json",
90 "description": "Data format for response.", 69 "description": "Data format for response.",
91 "enum": [ 70 "enum": [
92 "json", 71 "json",
93 "media", 72 "media",
94 "proto" 73 "proto"
95 ], 74 ],
96 "enumDescriptions": [ 75 "enumDescriptions": [
97 "Responses with Content-Type of application/json", 76 "Responses with Content-Type of application/json",
98 "Media download with context-dependent Content-Type", 77 "Media download with context-dependent Content-Type",
99 "Responses with Content-Type of application/x-protobuf" 78 "Responses with Content-Type of application/x-protobuf"
100 ], 79 ],
101 "location": "query", 80 "location": "query",
102 "type": "string" 81 "type": "string"
103 }, 82 },
83 "access_token": {
84 "description": "OAuth access token.",
85 "location": "query",
86 "type": "string"
87 },
104 "key": { 88 "key": {
105 "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.", 89 "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.",
106 "location": "query", 90 "location": "query",
107 "type": "string" 91 "type": "string"
108 }, 92 },
109 "access_token": { 93 "quotaUser": {
110 "description": "OAuth access token.", 94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
95 "location": "query",
96 "type": "string"
97 },
98 "pp": {
99 "default": "true",
100 "description": "Pretty-print response.",
101 "location": "query",
102 "type": "boolean"
103 },
104 "bearer_token": {
105 "description": "OAuth bearer token.",
106 "location": "query",
107 "type": "string"
108 },
109 "oauth_token": {
110 "description": "OAuth 2.0 token for the current user.",
111 "location": "query", 111 "location": "query",
112 "type": "string" 112 "type": "string"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "speech": {
118 "methods": {
119 "asyncrecognize": {
120 "description": "Performs asynchronous speech recognition: re ceive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/ v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` o r an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
121 "httpMethod": "POST",
122 "id": "speech.speech.asyncrecognize",
123 "parameterOrder": [],
124 "parameters": {},
125 "path": "v1beta1/speech:asyncrecognize",
126 "request": {
127 "$ref": "AsyncRecognizeRequest"
128 },
129 "response": {
130 "$ref": "Operation"
131 },
132 "scopes": [
133 "https://www.googleapis.com/auth/cloud-platform"
134 ]
135 },
136 "syncrecognize": {
137 "description": "Performs synchronous speech recognition: rec eive results after all audio\nhas been sent and processed.",
138 "httpMethod": "POST",
139 "id": "speech.speech.syncrecognize",
140 "parameterOrder": [],
141 "parameters": {},
142 "path": "v1beta1/speech:syncrecognize",
143 "request": {
144 "$ref": "SyncRecognizeRequest"
145 },
146 "response": {
147 "$ref": "SyncRecognizeResponse"
148 },
149 "scopes": [
150 "https://www.googleapis.com/auth/cloud-platform"
151 ]
152 }
153 }
154 },
155 "operations": { 117 "operations": {
156 "methods": { 118 "methods": {
157 "list": { 119 "list": {
158 "description": "Lists operations that match the specified fi lter in the request. If the\nserver doesn't support this method, it returns `UNI MPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override t he binding\nto use different resource name schemes, such as `users/*/operations` .", 120 "description": "Lists operations that match the specified fi lter in the request. If the\nserver doesn't support this method, it returns `UNI MPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the bin ding\nto use different resource name schemes, such as `users/*/operations`. To\n override the binding, API services can add a binding such as\n`\"/v1/{name=users /*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding user s must ensure the name binding\nis the parent resource, without the operations c ollection id.",
159 "httpMethod": "GET", 121 "httpMethod": "GET",
160 "id": "speech.operations.list", 122 "id": "speech.operations.list",
161 "parameterOrder": [], 123 "parameterOrder": [],
162 "parameters": { 124 "parameters": {
163 "name": { 125 "filter": {
164 "description": "The name of the operation collection .", 126 "description": "The standard list filter.",
165 "location": "query", 127 "location": "query",
166 "type": "string" 128 "type": "string"
167 }, 129 },
130 "name": {
131 "description": "The name of the operation's parent r esource.",
132 "location": "query",
133 "type": "string"
134 },
168 "pageToken": { 135 "pageToken": {
169 "description": "The standard list page token.", 136 "description": "The standard list page token.",
170 "location": "query", 137 "location": "query",
171 "type": "string" 138 "type": "string"
172 }, 139 },
173 "pageSize": { 140 "pageSize": {
174 "description": "The standard list page size.", 141 "description": "The standard list page size.",
175 "format": "int32", 142 "format": "int32",
176 "location": "query", 143 "location": "query",
177 "type": "integer" 144 "type": "integer"
178 },
179 "filter": {
180 "description": "The standard list filter.",
181 "location": "query",
182 "type": "string"
183 } 145 }
184 }, 146 },
185 "path": "v1beta1/operations", 147 "path": "v1beta1/operations",
186 "response": { 148 "response": {
187 "$ref": "ListOperationsResponse" 149 "$ref": "ListOperationsResponse"
188 }, 150 },
189 "scopes": [ 151 "scopes": [
190 "https://www.googleapis.com/auth/cloud-platform" 152 "https://www.googleapis.com/auth/cloud-platform"
191 ] 153 ]
192 }, 154 },
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
256 }, 218 },
257 "path": "v1beta1/operations/{+name}", 219 "path": "v1beta1/operations/{+name}",
258 "response": { 220 "response": {
259 "$ref": "Empty" 221 "$ref": "Empty"
260 }, 222 },
261 "scopes": [ 223 "scopes": [
262 "https://www.googleapis.com/auth/cloud-platform" 224 "https://www.googleapis.com/auth/cloud-platform"
263 ] 225 ]
264 } 226 }
265 } 227 }
228 },
229 "speech": {
230 "methods": {
231 "asyncrecognize": {
232 "description": "Performs asynchronous speech recognition: re ceive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/ v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` o r an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
233 "httpMethod": "POST",
234 "id": "speech.speech.asyncrecognize",
235 "parameterOrder": [],
236 "parameters": {},
237 "path": "v1beta1/speech:asyncrecognize",
238 "request": {
239 "$ref": "AsyncRecognizeRequest"
240 },
241 "response": {
242 "$ref": "Operation"
243 },
244 "scopes": [
245 "https://www.googleapis.com/auth/cloud-platform"
246 ]
247 },
248 "syncrecognize": {
249 "description": "Performs synchronous speech recognition: rec eive results after all audio\nhas been sent and processed.",
250 "httpMethod": "POST",
251 "id": "speech.speech.syncrecognize",
252 "parameterOrder": [],
253 "parameters": {},
254 "path": "v1beta1/speech:syncrecognize",
255 "request": {
256 "$ref": "SyncRecognizeRequest"
257 },
258 "response": {
259 "$ref": "SyncRecognizeResponse"
260 },
261 "scopes": [
262 "https://www.googleapis.com/auth/cloud-platform"
263 ]
264 }
265 }
266 } 266 }
267 }, 267 },
268 "revision": "20170516", 268 "revision": "20170609",
269 "rootUrl": "https://speech.googleapis.com/", 269 "rootUrl": "https://speech.googleapis.com/",
270 "schemas": { 270 "schemas": {
271 "Empty": {
272 "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 `{}`.",
273 "id": "Empty",
274 "properties": {},
275 "type": "object"
276 },
271 "SpeechRecognitionAlternative": { 277 "SpeechRecognitionAlternative": {
272 "description": "Alternative hypotheses (a.k.a. n-best list).", 278 "description": "Alternative hypotheses (a.k.a. n-best list).",
273 "id": "SpeechRecognitionAlternative", 279 "id": "SpeechRecognitionAlternative",
274 "properties": { 280 "properties": {
275 "confidence": { 281 "confidence": {
276 "description": "*Output-only* The confidence estimate betwee n 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that t he recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely o n the\n`confidence` field as it is not guaranteed to be accurate, or even set, i n\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confi dence` was not set.", 282 "description": "*Output-only* The confidence estimate betwee n 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that t he recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely o n the\n`confidence` field as it is not guaranteed to be accurate, or even set, i n\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confi dence` was not set.",
277 "format": "float", 283 "format": "float",
278 "type": "number" 284 "type": "number"
279 }, 285 },
280 "transcript": { 286 "transcript": {
(...skipping 14 matching lines...) Expand all
295 }, 301 },
296 "type": "array" 302 "type": "array"
297 } 303 }
298 }, 304 },
299 "type": "object" 305 "type": "object"
300 }, 306 },
301 "ListOperationsResponse": { 307 "ListOperationsResponse": {
302 "description": "The response message for Operations.ListOperations." , 308 "description": "The response message for Operations.ListOperations." ,
303 "id": "ListOperationsResponse", 309 "id": "ListOperationsResponse",
304 "properties": { 310 "properties": {
305 "nextPageToken": {
306 "description": "The standard List next-page token.",
307 "type": "string"
308 },
309 "operations": { 311 "operations": {
310 "description": "A list of operations that matches the specif ied filter in the request.", 312 "description": "A list of operations that matches the specif ied filter in the request.",
311 "items": { 313 "items": {
312 "$ref": "Operation" 314 "$ref": "Operation"
313 }, 315 },
314 "type": "array" 316 "type": "array"
317 },
318 "nextPageToken": {
319 "description": "The standard List next-page token.",
320 "type": "string"
315 } 321 }
316 }, 322 },
317 "type": "object" 323 "type": "object"
318 }, 324 },
319 "SpeechRecognitionResult": { 325 "SpeechRecognitionResult": {
320 "description": "A speech recognition result corresponding to a porti on of the audio.", 326 "description": "A speech recognition result corresponding to a porti on of the audio.",
321 "id": "SpeechRecognitionResult", 327 "id": "SpeechRecognitionResult",
322 "properties": { 328 "properties": {
323 "alternatives": { 329 "alternatives": {
324 "description": "*Output-only* May contain one or more recogn ition hypotheses (up to the\nmaximum specified in `max_alternatives`).", 330 "description": "*Output-only* May contain one or more recogn ition hypotheses (up to the\nmaximum specified in `max_alternatives`).",
325 "items": { 331 "items": {
326 "$ref": "SpeechRecognitionAlternative" 332 "$ref": "SpeechRecognitionAlternative"
327 }, 333 },
328 "type": "array" 334 "type": "array"
329 } 335 }
330 }, 336 },
331 "type": "object" 337 "type": "object"
332 }, 338 },
333 "AsyncRecognizeRequest": {
334 "description": "The top-level message sent by the client for the `As yncRecognize` method.",
335 "id": "AsyncRecognizeRequest",
336 "properties": {
337 "config": {
338 "$ref": "RecognitionConfig",
339 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request."
340 },
341 "audio": {
342 "$ref": "RecognitionAudio",
343 "description": "*Required* The audio data to be recognized."
344 }
345 },
346 "type": "object"
347 },
348 "RecognitionAudio": { 339 "RecognitionAudio": {
349 "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying bot h or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](http s://cloud.google.com/speech/limits#content).", 340 "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying bot h or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](http s://cloud.google.com/speech/limits#content).",
350 "id": "RecognitionAudio", 341 "id": "RecognitionAudio",
351 "properties": { 342 "properties": {
352 "content": { 343 "content": {
353 "description": "The audio data bytes encoded as specified in \n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.", 344 "description": "The audio data bytes encoded as specified in \n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
354 "format": "byte", 345 "format": "byte",
355 "type": "string" 346 "type": "string"
356 }, 347 },
357 "uri": { 348 "uri": {
358 "description": "URI that points to a file that contains audi o data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n` gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID _ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/s torage/docs/reference-uris).", 349 "description": "URI that points to a file that contains audi o data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n` gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID _ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/s torage/docs/reference-uris).",
359 "type": "string" 350 "type": "string"
360 } 351 }
361 }, 352 },
362 "type": "object" 353 "type": "object"
363 }, 354 },
355 "AsyncRecognizeRequest": {
356 "description": "The top-level message sent by the client for the `As yncRecognize` method.",
357 "id": "AsyncRecognizeRequest",
358 "properties": {
359 "config": {
360 "$ref": "RecognitionConfig",
361 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request."
362 },
363 "audio": {
364 "$ref": "RecognitionAudio",
365 "description": "*Required* The audio data to be recognized."
366 }
367 },
368 "type": "object"
369 },
364 "Operation": { 370 "Operation": {
365 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 371 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
366 "id": "Operation", 372 "id": "Operation",
367 "properties": { 373 "properties": {
368 "done": { 374 "done": {
369 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.", 375 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
370 "type": "boolean" 376 "type": "boolean"
371 }, 377 },
372 "response": { 378 "response": {
373 "additionalProperties": { 379 "additionalProperties": {
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
453 "$ref": "RecognitionConfig", 459 "$ref": "RecognitionConfig",
454 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request." 460 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request."
455 }, 461 },
456 "audio": { 462 "audio": {
457 "$ref": "RecognitionAudio", 463 "$ref": "RecognitionAudio",
458 "description": "*Required* The audio data to be recognized." 464 "description": "*Required* The audio data to be recognized."
459 } 465 }
460 }, 466 },
461 "type": "object" 467 "type": "object"
462 }, 468 },
469 "SyncRecognizeResponse": {
470 "description": "The only message returned to the client by `SyncReco gnize`. method. It\ncontains the result as zero or more sequential `SpeechRecogn itionResult`\nmessages.",
471 "id": "SyncRecognizeResponse",
472 "properties": {
473 "results": {
474 "description": "*Output-only* Sequential list of transcripti on results corresponding to\nsequential portions of audio.",
475 "items": {
476 "$ref": "SpeechRecognitionResult"
477 },
478 "type": "array"
479 }
480 },
481 "type": "object"
482 },
463 "Status": { 483 "Status": {
464 "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.", 484 "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.",
465 "id": "Status", 485 "id": "Status",
466 "properties": { 486 "properties": {
467 "code": {
468 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
469 "format": "int32",
470 "type": "integer"
471 },
472 "message": { 487 "message": {
473 "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.", 488 "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.",
474 "type": "string" 489 "type": "string"
475 }, 490 },
476 "details": { 491 "details": {
477 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 492 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
478 "items": { 493 "items": {
479 "additionalProperties": { 494 "additionalProperties": {
480 "description": "Properties of the object. Contains f ield @type with type URL.", 495 "description": "Properties of the object. Contains f ield @type with type URL.",
481 "type": "any" 496 "type": "any"
482 }, 497 },
483 "type": "object" 498 "type": "object"
484 }, 499 },
485 "type": "array" 500 "type": "array"
501 },
502 "code": {
503 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
504 "format": "int32",
505 "type": "integer"
486 } 506 }
487 }, 507 },
488 "type": "object" 508 "type": "object"
489 },
490 "SyncRecognizeResponse": {
491 "description": "The only message returned to the client by `SyncReco gnize`. method. It\ncontains the result as zero or more sequential `SpeechRecogn itionResult`\nmessages.",
492 "id": "SyncRecognizeResponse",
493 "properties": {
494 "results": {
495 "description": "*Output-only* Sequential list of transcripti on results corresponding to\nsequential portions of audio.",
496 "items": {
497 "$ref": "SpeechRecognitionResult"
498 },
499 "type": "array"
500 }
501 },
502 "type": "object"
503 },
504 "Empty": {
505 "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 `{}`.",
506 "id": "Empty",
507 "properties": {},
508 "type": "object"
509 } 509 }
510 }, 510 },
511 "servicePath": "", 511 "servicePath": "",
512 "title": "Google Cloud Speech API", 512 "title": "Google Cloud Speech API",
513 "version": "v1beta1" 513 "version": "v1beta1"
514 } 514 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/runtimeconfig__v1beta1.json ('k') | discovery/googleapis_beta/sqladmin__v1beta3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698