OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloudruntimeconfig": { |
| 6 "description": "Manage your Google Cloud Platform services'
runtime configuration" |
| 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 }, | |
8 "https://www.googleapis.com/auth/cloudruntimeconfig": { | |
9 "description": "Manage your Google Cloud Platform services'
runtime configuration" | |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://runtimeconfig.googleapis.com/", | 15 "baseUrl": "https://runtimeconfig.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Cloud RuntimeConfig", | 17 "canonicalName": "Cloud RuntimeConfig", |
18 "description": "Provides capabilities for dynamic configuration and coordina
tion for applications running on Google Cloud Platform.\n", | 18 "description": "Provides capabilities for dynamic configuration and coordina
tion for applications running on Google Cloud Platform.\n", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://cloud.google.com/deployment-manager/runtime-co
nfigurator/", | 20 "documentationLink": "https://cloud.google.com/deployment-manager/runtime-co
nfigurator/", |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "runtimeconfig:v1", | 25 "id": "runtimeconfig:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "runtimeconfig", | 27 "name": "runtimeconfig", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "access_token": { | 31 "upload_protocol": { |
32 "description": "OAuth access token.", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 33 "location": "query", |
34 "type": "string" | 34 "type": "string" |
35 }, | 35 }, |
36 "prettyPrint": { | 36 "prettyPrint": { |
37 "default": "true", | 37 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 39 "location": "query", |
40 "type": "boolean" | 40 "type": "boolean" |
41 }, | 41 }, |
42 "key": { | |
43 "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.", | |
44 "location": "query", | |
45 "type": "string" | |
46 }, | |
47 "quotaUser": { | |
48 "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.", | |
49 "location": "query", | |
50 "type": "string" | |
51 }, | |
52 "pp": { | |
53 "default": "true", | |
54 "description": "Pretty-print response.", | |
55 "location": "query", | |
56 "type": "boolean" | |
57 }, | |
58 "fields": { | 42 "fields": { |
59 "description": "Selector specifying which fields to include in a par
tial response.", | 43 "description": "Selector specifying which fields to include in a par
tial response.", |
60 "location": "query", | 44 "location": "query", |
61 "type": "string" | 45 "type": "string" |
62 }, | 46 }, |
| 47 "uploadType": { |
| 48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "$.xgafv": { |
| 53 "description": "V1 error format.", |
| 54 "enum": [ |
| 55 "1", |
| 56 "2" |
| 57 ], |
| 58 "enumDescriptions": [ |
| 59 "v1 error format", |
| 60 "v2 error format" |
| 61 ], |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
| 65 "callback": { |
| 66 "description": "JSONP", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
63 "alt": { | 70 "alt": { |
64 "default": "json", | 71 "default": "json", |
65 "description": "Data format for response.", | 72 "description": "Data format for response.", |
66 "enum": [ | 73 "enum": [ |
67 "json", | 74 "json", |
68 "media", | 75 "media", |
69 "proto" | 76 "proto" |
70 ], | 77 ], |
71 "enumDescriptions": [ | 78 "enumDescriptions": [ |
72 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
73 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
74 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
75 ], | 82 ], |
76 "location": "query", | 83 "location": "query", |
77 "type": "string" | 84 "type": "string" |
78 }, | 85 }, |
79 "$.xgafv": { | 86 "access_token": { |
80 "description": "V1 error format.", | 87 "description": "OAuth access token.", |
81 "enum": [ | |
82 "1", | |
83 "2" | |
84 ], | |
85 "enumDescriptions": [ | |
86 "v1 error format", | |
87 "v2 error format" | |
88 ], | |
89 "location": "query", | 88 "location": "query", |
90 "type": "string" | 89 "type": "string" |
91 }, | 90 }, |
92 "callback": { | 91 "key": { |
93 "description": "JSONP", | 92 "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.", |
94 "location": "query", | 93 "location": "query", |
95 "type": "string" | 94 "type": "string" |
96 }, | 95 }, |
97 "oauth_token": { | 96 "quotaUser": { |
98 "description": "OAuth 2.0 token for the current user.", | 97 "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.", |
99 "location": "query", | 98 "location": "query", |
100 "type": "string" | 99 "type": "string" |
101 }, | 100 }, |
102 "uploadType": { | 101 "pp": { |
103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 102 "default": "true", |
| 103 "description": "Pretty-print response.", |
| 104 "location": "query", |
| 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
104 "location": "query", | 109 "location": "query", |
105 "type": "string" | 110 "type": "string" |
106 }, | 111 }, |
107 "bearer_token": { | 112 "bearer_token": { |
108 "description": "OAuth bearer token.", | 113 "description": "OAuth bearer token.", |
109 "location": "query", | 114 "location": "query", |
110 "type": "string" | 115 "type": "string" |
111 }, | |
112 "upload_protocol": { | |
113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "operations": { | 120 "operations": { |
121 "methods": { | 121 "methods": { |
122 "list": { | |
123 "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`
.", | |
124 "httpMethod": "GET", | |
125 "id": "runtimeconfig.operations.list", | |
126 "parameterOrder": [ | |
127 "name" | |
128 ], | |
129 "parameters": { | |
130 "pageSize": { | |
131 "description": "The standard list page size.", | |
132 "format": "int32", | |
133 "location": "query", | |
134 "type": "integer" | |
135 }, | |
136 "filter": { | |
137 "description": "The standard list filter.", | |
138 "location": "query", | |
139 "type": "string" | |
140 }, | |
141 "name": { | |
142 "description": "The name of the operation collection
.", | |
143 "location": "path", | |
144 "pattern": "^operations$", | |
145 "required": true, | |
146 "type": "string" | |
147 }, | |
148 "pageToken": { | |
149 "description": "The standard list page token.", | |
150 "location": "query", | |
151 "type": "string" | |
152 } | |
153 }, | |
154 "path": "v1/{+name}", | |
155 "response": { | |
156 "$ref": "ListOperationsResponse" | |
157 }, | |
158 "scopes": [ | |
159 "https://www.googleapis.com/auth/cloud-platform", | |
160 "https://www.googleapis.com/auth/cloudruntimeconfig" | |
161 ] | |
162 }, | |
163 "delete": { | 122 "delete": { |
164 "description": "Deletes a long-running operation. This metho
d indicates that the client is\nno longer interested in the operation result. It
does not cancel the\noperation. If the server doesn't support this method, it r
eturns\n`google.rpc.Code.UNIMPLEMENTED`.", | 123 "description": "Deletes a long-running operation. This metho
d indicates that the client is\nno longer interested in the operation result. It
does not cancel the\noperation. If the server doesn't support this method, it r
eturns\n`google.rpc.Code.UNIMPLEMENTED`.", |
165 "httpMethod": "DELETE", | 124 "httpMethod": "DELETE", |
166 "id": "runtimeconfig.operations.delete", | 125 "id": "runtimeconfig.operations.delete", |
167 "parameterOrder": [ | 126 "parameterOrder": [ |
168 "name" | 127 "name" |
169 ], | 128 ], |
170 "parameters": { | 129 "parameters": { |
171 "name": { | 130 "name": { |
172 "description": "The name of the operation resource t
o be deleted.", | 131 "description": "The name of the operation resource t
o be deleted.", |
173 "location": "path", | 132 "location": "path", |
174 "pattern": "^operations/.+$", | 133 "pattern": "^operations/.+$", |
175 "required": true, | 134 "required": true, |
176 "type": "string" | 135 "type": "string" |
177 } | 136 } |
178 }, | 137 }, |
179 "path": "v1/{+name}", | 138 "path": "v1/{+name}", |
180 "response": { | 139 "response": { |
181 "$ref": "Empty" | 140 "$ref": "Empty" |
182 }, | 141 }, |
183 "scopes": [ | 142 "scopes": [ |
184 "https://www.googleapis.com/auth/cloud-platform", | 143 "https://www.googleapis.com/auth/cloud-platform", |
| 144 "https://www.googleapis.com/auth/cloudruntimeconfig" |
| 145 ] |
| 146 }, |
| 147 "list": { |
| 148 "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`
.", |
| 149 "httpMethod": "GET", |
| 150 "id": "runtimeconfig.operations.list", |
| 151 "parameterOrder": [ |
| 152 "name" |
| 153 ], |
| 154 "parameters": { |
| 155 "name": { |
| 156 "description": "The name of the operation collection
.", |
| 157 "location": "path", |
| 158 "pattern": "^operations$", |
| 159 "required": true, |
| 160 "type": "string" |
| 161 }, |
| 162 "pageToken": { |
| 163 "description": "The standard list page token.", |
| 164 "location": "query", |
| 165 "type": "string" |
| 166 }, |
| 167 "pageSize": { |
| 168 "description": "The standard list page size.", |
| 169 "format": "int32", |
| 170 "location": "query", |
| 171 "type": "integer" |
| 172 }, |
| 173 "filter": { |
| 174 "description": "The standard list filter.", |
| 175 "location": "query", |
| 176 "type": "string" |
| 177 } |
| 178 }, |
| 179 "path": "v1/{+name}", |
| 180 "response": { |
| 181 "$ref": "ListOperationsResponse" |
| 182 }, |
| 183 "scopes": [ |
| 184 "https://www.googleapis.com/auth/cloud-platform", |
185 "https://www.googleapis.com/auth/cloudruntimeconfig" | 185 "https://www.googleapis.com/auth/cloudruntimeconfig" |
186 ] | 186 ] |
187 }, | 187 }, |
188 "cancel": { | 188 "cancel": { |
189 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server\nmakes a best effort to cancel the operation, but
success is not\nguaranteed. If the server doesn't support this method, it retur
ns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation o
r\nother methods to check whether the cancellation succeeded or whether the\nope
ration completed despite cancellation. On successful cancellation,\nthe operatio
n is not deleted; instead, it becomes an operation with\nan Operation.error valu
e with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", | 189 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server\nmakes a best effort to cancel the operation, but
success is not\nguaranteed. If the server doesn't support this method, it retur
ns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation o
r\nother methods to check whether the cancellation succeeded or whether the\nope
ration completed despite cancellation. On successful cancellation,\nthe operatio
n is not deleted; instead, it becomes an operation with\nan Operation.error valu
e with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", |
190 "httpMethod": "POST", | 190 "httpMethod": "POST", |
191 "id": "runtimeconfig.operations.cancel", | 191 "id": "runtimeconfig.operations.cancel", |
192 "parameterOrder": [ | 192 "parameterOrder": [ |
193 "name" | 193 "name" |
194 ], | 194 ], |
(...skipping 14 matching lines...) Expand all Loading... |
209 "$ref": "Empty" | 209 "$ref": "Empty" |
210 }, | 210 }, |
211 "scopes": [ | 211 "scopes": [ |
212 "https://www.googleapis.com/auth/cloud-platform", | 212 "https://www.googleapis.com/auth/cloud-platform", |
213 "https://www.googleapis.com/auth/cloudruntimeconfig" | 213 "https://www.googleapis.com/auth/cloudruntimeconfig" |
214 ] | 214 ] |
215 } | 215 } |
216 } | 216 } |
217 } | 217 } |
218 }, | 218 }, |
219 "revision": "20170109", | 219 "revision": "20170123", |
220 "rootUrl": "https://runtimeconfig.googleapis.com/", | 220 "rootUrl": "https://runtimeconfig.googleapis.com/", |
221 "schemas": { | 221 "schemas": { |
222 "ListOperationsResponse": { | 222 "ListOperationsResponse": { |
223 "description": "The response message for Operations.ListOperations."
, | 223 "description": "The response message for Operations.ListOperations."
, |
224 "id": "ListOperationsResponse", | 224 "id": "ListOperationsResponse", |
225 "properties": { | 225 "properties": { |
226 "nextPageToken": { | |
227 "description": "The standard List next-page token.", | |
228 "type": "string" | |
229 }, | |
230 "operations": { | 226 "operations": { |
231 "description": "A list of operations that matches the specif
ied filter in the request.", | 227 "description": "A list of operations that matches the specif
ied filter in the request.", |
232 "items": { | 228 "items": { |
233 "$ref": "Operation" | 229 "$ref": "Operation" |
234 }, | 230 }, |
235 "type": "array" | 231 "type": "array" |
236 } | |
237 }, | |
238 "type": "object" | |
239 }, | |
240 "Empty": { | |
241 "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 `{}`.", | |
242 "id": "Empty", | |
243 "properties": {}, | |
244 "type": "object" | |
245 }, | |
246 "Status": { | |
247 "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` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e 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
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", | |
248 "id": "Status", | |
249 "properties": { | |
250 "code": { | |
251 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
252 "format": "int32", | |
253 "type": "integer" | |
254 }, | 232 }, |
255 "details": { | 233 "nextPageToken": { |
256 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | 234 "description": "The standard List next-page token.", |
257 "items": { | |
258 "additionalProperties": { | |
259 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
260 "type": "any" | |
261 }, | |
262 "type": "object" | |
263 }, | |
264 "type": "array" | |
265 }, | |
266 "message": { | |
267 "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.", | |
268 "type": "string" | 235 "type": "string" |
269 } | 236 } |
270 }, | 237 }, |
271 "type": "object" | 238 "type": "object" |
272 }, | 239 }, |
273 "Operation": { | 240 "Operation": { |
274 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | 241 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
275 "id": "Operation", | 242 "id": "Operation", |
276 "properties": { | 243 "properties": { |
| 244 "name": { |
| 245 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
| 246 "type": "string" |
| 247 }, |
277 "error": { | 248 "error": { |
278 "$ref": "Status", | 249 "$ref": "Status", |
279 "description": "The error result of the operation in case of
failure or cancellation." | 250 "description": "The error result of the operation in case of
failure or cancellation." |
280 }, | 251 }, |
281 "done": { | |
282 "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.", | |
283 "type": "boolean" | |
284 }, | |
285 "metadata": { | 252 "metadata": { |
286 "additionalProperties": { | 253 "additionalProperties": { |
287 "description": "Properties of the object. Contains field
@type with type URL.", | 254 "description": "Properties of the object. Contains field
@type with type URL.", |
288 "type": "any" | 255 "type": "any" |
289 }, | 256 }, |
290 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", | 257 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", |
291 "type": "object" | 258 "type": "object" |
292 }, | 259 }, |
| 260 "done": { |
| 261 "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.", |
| 262 "type": "boolean" |
| 263 }, |
293 "response": { | 264 "response": { |
294 "additionalProperties": { | 265 "additionalProperties": { |
295 "description": "Properties of the object. Contains field
@type with type URL.", | 266 "description": "Properties of the object. Contains field
@type with type URL.", |
296 "type": "any" | 267 "type": "any" |
297 }, | 268 }, |
298 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", | 269 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
299 "type": "object" | 270 "type": "object" |
300 }, | |
301 "name": { | |
302 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", | |
303 "type": "string" | |
304 } | 271 } |
305 }, | 272 }, |
306 "type": "object" | 273 "type": "object" |
307 }, | 274 }, |
| 275 "Empty": { |
| 276 "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 `{}`.", |
| 277 "id": "Empty", |
| 278 "properties": {}, |
| 279 "type": "object" |
| 280 }, |
308 "CancelOperationRequest": { | 281 "CancelOperationRequest": { |
309 "description": "The request message for Operations.CancelOperation."
, | 282 "description": "The request message for Operations.CancelOperation."
, |
310 "id": "CancelOperationRequest", | 283 "id": "CancelOperationRequest", |
311 "properties": {}, | 284 "properties": {}, |
312 "type": "object" | 285 "type": "object" |
| 286 }, |
| 287 "Status": { |
| 288 "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` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e 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
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
| 289 "id": "Status", |
| 290 "properties": { |
| 291 "code": { |
| 292 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 293 "format": "int32", |
| 294 "type": "integer" |
| 295 }, |
| 296 "message": { |
| 297 "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.", |
| 298 "type": "string" |
| 299 }, |
| 300 "details": { |
| 301 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 302 "items": { |
| 303 "additionalProperties": { |
| 304 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 305 "type": "any" |
| 306 }, |
| 307 "type": "object" |
| 308 }, |
| 309 "type": "array" |
| 310 } |
| 311 }, |
| 312 "type": "object" |
313 } | 313 } |
314 }, | 314 }, |
315 "servicePath": "", | 315 "servicePath": "", |
316 "title": "Google Cloud RuntimeConfig API", | 316 "title": "Google Cloud RuntimeConfig API", |
317 "version": "v1" | 317 "version": "v1" |
318 } | 318 } |
OLD | NEW |