OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/datastore": { | 5 "https://www.googleapis.com/auth/datastore": { |
6 "description": "View and manage your Google Cloud Datastore
data" | 6 "description": "View and manage your Google Cloud Datastore
data" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
9 "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" |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://datastore.googleapis.com/", | 15 "baseUrl": "https://datastore.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "description": "Accesses the schemaless NoSQL database to provide fully mana
ged, robust, scalable storage for your application.\n", | 17 "description": "Accesses the schemaless NoSQL database to provide fully mana
ged, robust, scalable storage for your application.\n", |
18 "discoveryVersion": "v1", | 18 "discoveryVersion": "v1", |
19 "documentationLink": "https://cloud.google.com/datastore/", | 19 "documentationLink": "https://cloud.google.com/datastore/", |
20 "icons": { | 20 "icons": { |
21 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 21 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
22 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 22 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
23 }, | 23 }, |
24 "id": "datastore:v1", | 24 "id": "datastore:v1", |
25 "kind": "discovery#restDescription", | 25 "kind": "discovery#restDescription", |
26 "name": "datastore", | 26 "name": "datastore", |
27 "ownerDomain": "google.com", | 27 "ownerDomain": "google.com", |
28 "ownerName": "Google", | 28 "ownerName": "Google", |
29 "parameters": { | 29 "parameters": { |
| 30 "oauth_token": { |
| 31 "description": "OAuth 2.0 token for the current user.", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
30 "bearer_token": { | 35 "bearer_token": { |
31 "description": "OAuth bearer token.", | 36 "description": "OAuth bearer token.", |
32 "location": "query", | 37 "location": "query", |
33 "type": "string" | 38 "type": "string" |
34 }, | 39 }, |
35 "oauth_token": { | |
36 "description": "OAuth 2.0 token for the current user.", | |
37 "location": "query", | |
38 "type": "string" | |
39 }, | |
40 "upload_protocol": { | 40 "upload_protocol": { |
41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
42 "location": "query", | 42 "location": "query", |
43 "type": "string" | 43 "type": "string" |
44 }, | 44 }, |
45 "prettyPrint": { | 45 "prettyPrint": { |
46 "default": "true", | 46 "default": "true", |
47 "description": "Returns response with indentations and line breaks."
, | 47 "description": "Returns response with indentations and line breaks."
, |
48 "location": "query", | 48 "location": "query", |
49 "type": "boolean" | 49 "type": "boolean" |
50 }, | 50 }, |
| 51 "fields": { |
| 52 "description": "Selector specifying which fields to include in a par
tial response.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
51 "uploadType": { | 56 "uploadType": { |
52 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 57 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
53 "location": "query", | 58 "location": "query", |
54 "type": "string" | 59 "type": "string" |
55 }, | 60 }, |
56 "fields": { | 61 "callback": { |
57 "description": "Selector specifying which fields to include in a par
tial response.", | 62 "description": "JSONP", |
58 "location": "query", | 63 "location": "query", |
59 "type": "string" | 64 "type": "string" |
60 }, | 65 }, |
61 "$.xgafv": { | 66 "$.xgafv": { |
62 "description": "V1 error format.", | 67 "description": "V1 error format.", |
63 "enum": [ | 68 "enum": [ |
64 "1", | 69 "1", |
65 "2" | 70 "2" |
66 ], | 71 ], |
67 "enumDescriptions": [ | 72 "enumDescriptions": [ |
68 "v1 error format", | 73 "v1 error format", |
69 "v2 error format" | 74 "v2 error format" |
70 ], | 75 ], |
71 "location": "query", | 76 "location": "query", |
72 "type": "string" | 77 "type": "string" |
73 }, | 78 }, |
74 "callback": { | |
75 "description": "JSONP", | |
76 "location": "query", | |
77 "type": "string" | |
78 }, | |
79 "alt": { | 79 "alt": { |
80 "default": "json", | 80 "default": "json", |
81 "description": "Data format for response.", | 81 "description": "Data format for response.", |
82 "enum": [ | 82 "enum": [ |
83 "json", | 83 "json", |
84 "media", | 84 "media", |
85 "proto" | 85 "proto" |
86 ], | 86 ], |
87 "enumDescriptions": [ | 87 "enumDescriptions": [ |
88 "Responses with Content-Type of application/json", | 88 "Responses with Content-Type of application/json", |
89 "Media download with context-dependent Content-Type", | 89 "Media download with context-dependent Content-Type", |
90 "Responses with Content-Type of application/x-protobuf" | 90 "Responses with Content-Type of application/x-protobuf" |
91 ], | 91 ], |
92 "location": "query", | 92 "location": "query", |
93 "type": "string" | 93 "type": "string" |
94 }, | 94 }, |
| 95 "key": { |
| 96 "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.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
95 "access_token": { | 100 "access_token": { |
96 "description": "OAuth access token.", | 101 "description": "OAuth access token.", |
97 "location": "query", | 102 "location": "query", |
98 "type": "string" | 103 "type": "string" |
99 }, | 104 }, |
100 "key": { | |
101 "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.", | |
102 "location": "query", | |
103 "type": "string" | |
104 }, | |
105 "quotaUser": { | 105 "quotaUser": { |
106 "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.", | 106 "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.", |
107 "location": "query", | 107 "location": "query", |
108 "type": "string" | 108 "type": "string" |
109 }, | 109 }, |
110 "pp": { | 110 "pp": { |
111 "default": "true", | 111 "default": "true", |
112 "description": "Pretty-print response.", | 112 "description": "Pretty-print response.", |
113 "location": "query", | 113 "location": "query", |
114 "type": "boolean" | 114 "type": "boolean" |
115 } | 115 } |
116 }, | 116 }, |
117 "protocol": "rest", | 117 "protocol": "rest", |
118 "resources": { | 118 "resources": { |
119 "projects": { | 119 "projects": { |
120 "methods": { | 120 "methods": { |
121 "beginTransaction": { | 121 "runQuery": { |
122 "description": "Begins a new transaction.", | 122 "description": "Queries for entities.", |
123 "httpMethod": "POST", | 123 "httpMethod": "POST", |
124 "id": "datastore.projects.beginTransaction", | 124 "id": "datastore.projects.runQuery", |
125 "parameterOrder": [ | 125 "parameterOrder": [ |
126 "projectId" | 126 "projectId" |
127 ], | 127 ], |
128 "parameters": { | 128 "parameters": { |
129 "projectId": { | 129 "projectId": { |
130 "description": "The ID of the project against which
to make the request.", | 130 "description": "The ID of the project against which
to make the request.", |
131 "location": "path", | 131 "location": "path", |
132 "required": true, | 132 "required": true, |
133 "type": "string" | 133 "type": "string" |
134 } | 134 } |
135 }, | 135 }, |
136 "path": "v1/projects/{projectId}:beginTransaction", | 136 "path": "v1/projects/{projectId}:runQuery", |
137 "request": { | 137 "request": { |
138 "$ref": "BeginTransactionRequest" | 138 "$ref": "RunQueryRequest" |
139 }, | 139 }, |
140 "response": { | 140 "response": { |
141 "$ref": "BeginTransactionResponse" | 141 "$ref": "RunQueryResponse" |
142 }, | 142 }, |
143 "scopes": [ | 143 "scopes": [ |
144 "https://www.googleapis.com/auth/cloud-platform", | 144 "https://www.googleapis.com/auth/cloud-platform", |
145 "https://www.googleapis.com/auth/datastore" | 145 "https://www.googleapis.com/auth/datastore" |
146 ] | 146 ] |
147 }, | 147 }, |
148 "commit": { | 148 "rollback": { |
149 "description": "Commits a transaction, optionally creating,
deleting or modifying some\nentities.", | 149 "description": "Rolls back a transaction.", |
150 "httpMethod": "POST", | 150 "httpMethod": "POST", |
151 "id": "datastore.projects.commit", | 151 "id": "datastore.projects.rollback", |
152 "parameterOrder": [ | 152 "parameterOrder": [ |
153 "projectId" | 153 "projectId" |
154 ], | 154 ], |
155 "parameters": { | 155 "parameters": { |
156 "projectId": { | 156 "projectId": { |
157 "description": "The ID of the project against which
to make the request.", | 157 "description": "The ID of the project against which
to make the request.", |
158 "location": "path", | 158 "location": "path", |
159 "required": true, | 159 "required": true, |
160 "type": "string" | 160 "type": "string" |
161 } | 161 } |
162 }, | 162 }, |
163 "path": "v1/projects/{projectId}:commit", | 163 "path": "v1/projects/{projectId}:rollback", |
164 "request": { | 164 "request": { |
165 "$ref": "CommitRequest" | 165 "$ref": "RollbackRequest" |
166 }, | 166 }, |
167 "response": { | 167 "response": { |
168 "$ref": "CommitResponse" | 168 "$ref": "RollbackResponse" |
169 }, | 169 }, |
170 "scopes": [ | 170 "scopes": [ |
171 "https://www.googleapis.com/auth/cloud-platform", | 171 "https://www.googleapis.com/auth/cloud-platform", |
172 "https://www.googleapis.com/auth/datastore" | 172 "https://www.googleapis.com/auth/datastore" |
173 ] | 173 ] |
174 }, | 174 }, |
175 "runQuery": { | 175 "lookup": { |
176 "description": "Queries for entities.", | 176 "description": "Looks up entities by key.", |
177 "httpMethod": "POST", | 177 "httpMethod": "POST", |
178 "id": "datastore.projects.runQuery", | 178 "id": "datastore.projects.lookup", |
179 "parameterOrder": [ | 179 "parameterOrder": [ |
180 "projectId" | 180 "projectId" |
181 ], | 181 ], |
182 "parameters": { | 182 "parameters": { |
183 "projectId": { | 183 "projectId": { |
184 "description": "The ID of the project against which
to make the request.", | 184 "description": "The ID of the project against which
to make the request.", |
185 "location": "path", | 185 "location": "path", |
186 "required": true, | 186 "required": true, |
187 "type": "string" | 187 "type": "string" |
188 } | 188 } |
189 }, | 189 }, |
190 "path": "v1/projects/{projectId}:runQuery", | 190 "path": "v1/projects/{projectId}:lookup", |
191 "request": { | 191 "request": { |
192 "$ref": "RunQueryRequest" | 192 "$ref": "LookupRequest" |
193 }, | 193 }, |
194 "response": { | 194 "response": { |
195 "$ref": "RunQueryResponse" | 195 "$ref": "LookupResponse" |
196 }, | 196 }, |
197 "scopes": [ | 197 "scopes": [ |
198 "https://www.googleapis.com/auth/cloud-platform", | 198 "https://www.googleapis.com/auth/cloud-platform", |
199 "https://www.googleapis.com/auth/datastore" | 199 "https://www.googleapis.com/auth/datastore" |
200 ] | 200 ] |
201 }, | 201 }, |
202 "rollback": { | 202 "allocateIds": { |
203 "description": "Rolls back a transaction.", | 203 "description": "Allocates IDs for the given keys, which is u
seful for referencing an entity\nbefore it is inserted.", |
204 "httpMethod": "POST", | 204 "httpMethod": "POST", |
205 "id": "datastore.projects.rollback", | 205 "id": "datastore.projects.allocateIds", |
206 "parameterOrder": [ | 206 "parameterOrder": [ |
207 "projectId" | 207 "projectId" |
208 ], | 208 ], |
209 "parameters": { | 209 "parameters": { |
210 "projectId": { | 210 "projectId": { |
211 "description": "The ID of the project against which
to make the request.", | 211 "description": "The ID of the project against which
to make the request.", |
212 "location": "path", | 212 "location": "path", |
213 "required": true, | 213 "required": true, |
214 "type": "string" | 214 "type": "string" |
215 } | 215 } |
216 }, | 216 }, |
217 "path": "v1/projects/{projectId}:rollback", | 217 "path": "v1/projects/{projectId}:allocateIds", |
218 "request": { | 218 "request": { |
219 "$ref": "RollbackRequest" | 219 "$ref": "AllocateIdsRequest" |
220 }, | 220 }, |
221 "response": { | 221 "response": { |
222 "$ref": "RollbackResponse" | 222 "$ref": "AllocateIdsResponse" |
223 }, | 223 }, |
224 "scopes": [ | 224 "scopes": [ |
225 "https://www.googleapis.com/auth/cloud-platform", | 225 "https://www.googleapis.com/auth/cloud-platform", |
226 "https://www.googleapis.com/auth/datastore" | 226 "https://www.googleapis.com/auth/datastore" |
227 ] | 227 ] |
228 }, | 228 }, |
229 "lookup": { | 229 "commit": { |
230 "description": "Looks up entities by key.", | 230 "description": "Commits a transaction, optionally creating,
deleting or modifying some\nentities.", |
231 "httpMethod": "POST", | 231 "httpMethod": "POST", |
232 "id": "datastore.projects.lookup", | 232 "id": "datastore.projects.commit", |
233 "parameterOrder": [ | 233 "parameterOrder": [ |
234 "projectId" | 234 "projectId" |
235 ], | 235 ], |
236 "parameters": { | 236 "parameters": { |
237 "projectId": { | 237 "projectId": { |
238 "description": "The ID of the project against which
to make the request.", | 238 "description": "The ID of the project against which
to make the request.", |
239 "location": "path", | 239 "location": "path", |
240 "required": true, | 240 "required": true, |
241 "type": "string" | 241 "type": "string" |
242 } | 242 } |
243 }, | 243 }, |
244 "path": "v1/projects/{projectId}:lookup", | 244 "path": "v1/projects/{projectId}:commit", |
245 "request": { | 245 "request": { |
246 "$ref": "LookupRequest" | 246 "$ref": "CommitRequest" |
247 }, | 247 }, |
248 "response": { | 248 "response": { |
249 "$ref": "LookupResponse" | 249 "$ref": "CommitResponse" |
250 }, | 250 }, |
251 "scopes": [ | 251 "scopes": [ |
252 "https://www.googleapis.com/auth/cloud-platform", | 252 "https://www.googleapis.com/auth/cloud-platform", |
253 "https://www.googleapis.com/auth/datastore" | 253 "https://www.googleapis.com/auth/datastore" |
254 ] | 254 ] |
255 }, | 255 }, |
256 "allocateIds": { | 256 "beginTransaction": { |
257 "description": "Allocates IDs for the given keys, which is u
seful for referencing an entity\nbefore it is inserted.", | 257 "description": "Begins a new transaction.", |
258 "httpMethod": "POST", | 258 "httpMethod": "POST", |
259 "id": "datastore.projects.allocateIds", | 259 "id": "datastore.projects.beginTransaction", |
260 "parameterOrder": [ | 260 "parameterOrder": [ |
261 "projectId" | 261 "projectId" |
262 ], | 262 ], |
263 "parameters": { | 263 "parameters": { |
264 "projectId": { | 264 "projectId": { |
265 "description": "The ID of the project against which
to make the request.", | 265 "description": "The ID of the project against which
to make the request.", |
266 "location": "path", | 266 "location": "path", |
267 "required": true, | 267 "required": true, |
268 "type": "string" | 268 "type": "string" |
269 } | 269 } |
270 }, | 270 }, |
271 "path": "v1/projects/{projectId}:allocateIds", | 271 "path": "v1/projects/{projectId}:beginTransaction", |
272 "request": { | 272 "request": { |
273 "$ref": "AllocateIdsRequest" | 273 "$ref": "BeginTransactionRequest" |
274 }, | 274 }, |
275 "response": { | 275 "response": { |
276 "$ref": "AllocateIdsResponse" | 276 "$ref": "BeginTransactionResponse" |
277 }, | 277 }, |
278 "scopes": [ | 278 "scopes": [ |
279 "https://www.googleapis.com/auth/cloud-platform", | 279 "https://www.googleapis.com/auth/cloud-platform", |
280 "https://www.googleapis.com/auth/datastore" | 280 "https://www.googleapis.com/auth/datastore" |
281 ] | 281 ] |
282 } | 282 } |
| 283 }, |
| 284 "resources": { |
| 285 "operations": { |
| 286 "methods": { |
| 287 "get": { |
| 288 "description": "Gets the latest state of a long-runn
ing operation. Clients can use this\nmethod to poll the operation result at int
ervals as recommended by the API\nservice.", |
| 289 "httpMethod": "GET", |
| 290 "id": "datastore.projects.operations.get", |
| 291 "parameterOrder": [ |
| 292 "name" |
| 293 ], |
| 294 "parameters": { |
| 295 "name": { |
| 296 "description": "The name of the operation re
source.", |
| 297 "location": "path", |
| 298 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 299 "required": true, |
| 300 "type": "string" |
| 301 } |
| 302 }, |
| 303 "path": "v1/{+name}", |
| 304 "response": { |
| 305 "$ref": "GoogleLongrunningOperation" |
| 306 }, |
| 307 "scopes": [ |
| 308 "https://www.googleapis.com/auth/cloud-platform"
, |
| 309 "https://www.googleapis.com/auth/datastore" |
| 310 ] |
| 311 }, |
| 312 "list": { |
| 313 "description": "Lists operations that match the spec
ified filter in the request. If the\nserver doesn't support this method, it retu
rns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override
the binding\nto use different resource name schemes, such as `users/*/operation
s`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{na
me=users/*}/operations\"` to their service configuration.\nFor backwards compati
bility, the default name includes the operations\ncollection id, however overrid
ing users must ensure the name binding\nis the parent resource, without the oper
ations collection id.", |
| 314 "httpMethod": "GET", |
| 315 "id": "datastore.projects.operations.list", |
| 316 "parameterOrder": [ |
| 317 "name" |
| 318 ], |
| 319 "parameters": { |
| 320 "pageSize": { |
| 321 "description": "The standard list page size.
", |
| 322 "format": "int32", |
| 323 "location": "query", |
| 324 "type": "integer" |
| 325 }, |
| 326 "filter": { |
| 327 "description": "The standard list filter.", |
| 328 "location": "query", |
| 329 "type": "string" |
| 330 }, |
| 331 "pageToken": { |
| 332 "description": "The standard list page token
.", |
| 333 "location": "query", |
| 334 "type": "string" |
| 335 }, |
| 336 "name": { |
| 337 "description": "The name of the operation's
parent resource.", |
| 338 "location": "path", |
| 339 "pattern": "^projects/[^/]+$", |
| 340 "required": true, |
| 341 "type": "string" |
| 342 } |
| 343 }, |
| 344 "path": "v1/{+name}/operations", |
| 345 "response": { |
| 346 "$ref": "GoogleLongrunningListOperationsResponse
" |
| 347 }, |
| 348 "scopes": [ |
| 349 "https://www.googleapis.com/auth/cloud-platform"
, |
| 350 "https://www.googleapis.com/auth/datastore" |
| 351 ] |
| 352 }, |
| 353 "cancel": { |
| 354 "description": "Starts asynchronous cancellation on
a long-running operation. The server\nmakes a best effort to cancel the operati
on, but success is not\nguaranteed. If the server doesn't support this method,
it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOpe
ration or\nother methods to check whether the cancellation succeeded or whether
the\noperation completed despite cancellation. On successful cancellation,\nthe
operation is not deleted; instead, it becomes an operation with\nan Operation.er
ror value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`
.", |
| 355 "httpMethod": "POST", |
| 356 "id": "datastore.projects.operations.cancel", |
| 357 "parameterOrder": [ |
| 358 "name" |
| 359 ], |
| 360 "parameters": { |
| 361 "name": { |
| 362 "description": "The name of the operation re
source to be cancelled.", |
| 363 "location": "path", |
| 364 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 365 "required": true, |
| 366 "type": "string" |
| 367 } |
| 368 }, |
| 369 "path": "v1/{+name}:cancel", |
| 370 "response": { |
| 371 "$ref": "Empty" |
| 372 }, |
| 373 "scopes": [ |
| 374 "https://www.googleapis.com/auth/cloud-platform"
, |
| 375 "https://www.googleapis.com/auth/datastore" |
| 376 ] |
| 377 }, |
| 378 "delete": { |
| 379 "description": "Deletes a long-running operation. Th
is method indicates that the client is\nno longer interested in the operation re
sult. It does not cancel the\noperation. If the server doesn't support this meth
od, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", |
| 380 "httpMethod": "DELETE", |
| 381 "id": "datastore.projects.operations.delete", |
| 382 "parameterOrder": [ |
| 383 "name" |
| 384 ], |
| 385 "parameters": { |
| 386 "name": { |
| 387 "description": "The name of the operation re
source to be deleted.", |
| 388 "location": "path", |
| 389 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 390 "required": true, |
| 391 "type": "string" |
| 392 } |
| 393 }, |
| 394 "path": "v1/{+name}", |
| 395 "response": { |
| 396 "$ref": "Empty" |
| 397 }, |
| 398 "scopes": [ |
| 399 "https://www.googleapis.com/auth/cloud-platform"
, |
| 400 "https://www.googleapis.com/auth/datastore" |
| 401 ] |
| 402 } |
| 403 } |
| 404 } |
283 } | 405 } |
284 } | 406 } |
285 }, | 407 }, |
286 "revision": "20170711", | 408 "revision": "20170811", |
287 "rootUrl": "https://datastore.googleapis.com/", | 409 "rootUrl": "https://datastore.googleapis.com/", |
288 "schemas": { | 410 "schemas": { |
289 "BeginTransactionResponse": { | |
290 "description": "The response for Datastore.BeginTransaction.", | |
291 "id": "BeginTransactionResponse", | |
292 "properties": { | |
293 "transaction": { | |
294 "description": "The transaction identifier (always present).
", | |
295 "format": "byte", | |
296 "type": "string" | |
297 } | |
298 }, | |
299 "type": "object" | |
300 }, | |
301 "AllocateIdsRequest": { | |
302 "description": "The request for Datastore.AllocateIds.", | |
303 "id": "AllocateIdsRequest", | |
304 "properties": { | |
305 "keys": { | |
306 "description": "A list of keys with incomplete key paths for
which to allocate IDs.\nNo key may be reserved/read-only.", | |
307 "items": { | |
308 "$ref": "Key" | |
309 }, | |
310 "type": "array" | |
311 } | |
312 }, | |
313 "type": "object" | |
314 }, | |
315 "LookupResponse": { | |
316 "description": "The response for Datastore.Lookup.", | |
317 "id": "LookupResponse", | |
318 "properties": { | |
319 "deferred": { | |
320 "description": "A list of keys that were not looked up due t
o resource constraints. The\norder of results in this field is undefined and has
no relation to the\norder of the keys in the input.", | |
321 "items": { | |
322 "$ref": "Key" | |
323 }, | |
324 "type": "array" | |
325 }, | |
326 "missing": { | |
327 "description": "Entities not found as `ResultType.KEY_ONLY`
entities. The order of results\nin this field is undefined and has no relation t
o the order of the keys\nin the input.", | |
328 "items": { | |
329 "$ref": "EntityResult" | |
330 }, | |
331 "type": "array" | |
332 }, | |
333 "found": { | |
334 "description": "Entities found as `ResultType.FULL` entities
. The order of results in this\nfield is undefined and has no relation to the or
der of the keys in the\ninput.", | |
335 "items": { | |
336 "$ref": "EntityResult" | |
337 }, | |
338 "type": "array" | |
339 } | |
340 }, | |
341 "type": "object" | |
342 }, | |
343 "RunQueryResponse": { | |
344 "description": "The response for Datastore.RunQuery.", | |
345 "id": "RunQueryResponse", | |
346 "properties": { | |
347 "query": { | |
348 "$ref": "Query", | |
349 "description": "The parsed form of the `GqlQuery` from the r
equest, if it was set." | |
350 }, | |
351 "batch": { | |
352 "$ref": "QueryResultBatch", | |
353 "description": "A batch of query results (always present)." | |
354 } | |
355 }, | |
356 "type": "object" | |
357 }, | |
358 "CommitRequest": { | |
359 "description": "The request for Datastore.Commit.", | |
360 "id": "CommitRequest", | |
361 "properties": { | |
362 "mode": { | |
363 "description": "The type of commit to perform. Defaults to `
TRANSACTIONAL`.", | |
364 "enum": [ | |
365 "MODE_UNSPECIFIED", | |
366 "TRANSACTIONAL", | |
367 "NON_TRANSACTIONAL" | |
368 ], | |
369 "enumDescriptions": [ | |
370 "Unspecified. This value must not be used.", | |
371 "Transactional: The mutations are either all applied, or
none are applied.\nLearn about transactions [here](https://cloud.google.com/dat
astore/docs/concepts/transactions).", | |
372 "Non-transactional: The mutations may not apply as all o
r none." | |
373 ], | |
374 "type": "string" | |
375 }, | |
376 "mutations": { | |
377 "description": "The mutations to perform.\n\nWhen mode is `T
RANSACTIONAL`, mutations affecting a single entity are\napplied in order. The fo
llowing sequences of mutations affecting a single\nentity are not permitted in a
single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followe
d by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\
n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentit
y.", | |
378 "items": { | |
379 "$ref": "Mutation" | |
380 }, | |
381 "type": "array" | |
382 }, | |
383 "transaction": { | |
384 "description": "The identifier of the transaction associated
with the commit. A\ntransaction identifier is returned by a call to\nDatastore.
BeginTransaction.", | |
385 "format": "byte", | |
386 "type": "string" | |
387 } | |
388 }, | |
389 "type": "object" | |
390 }, | |
391 "BeginTransactionRequest": { | |
392 "description": "The request for Datastore.BeginTransaction.", | |
393 "id": "BeginTransactionRequest", | |
394 "properties": {}, | |
395 "type": "object" | |
396 }, | |
397 "PropertyOrder": { | |
398 "description": "The desired order for a specific property.", | |
399 "id": "PropertyOrder", | |
400 "properties": { | |
401 "direction": { | |
402 "description": "The direction to order by. Defaults to `ASCE
NDING`.", | |
403 "enum": [ | |
404 "DIRECTION_UNSPECIFIED", | |
405 "ASCENDING", | |
406 "DESCENDING" | |
407 ], | |
408 "enumDescriptions": [ | |
409 "Unspecified. This value must not be used.", | |
410 "Ascending.", | |
411 "Descending." | |
412 ], | |
413 "type": "string" | |
414 }, | |
415 "property": { | |
416 "$ref": "PropertyReference", | |
417 "description": "The property to order by." | |
418 } | |
419 }, | |
420 "type": "object" | |
421 }, | |
422 "KindExpression": { | |
423 "description": "A representation of a kind.", | |
424 "id": "KindExpression", | |
425 "properties": { | |
426 "name": { | |
427 "description": "The name of the kind.", | |
428 "type": "string" | |
429 } | |
430 }, | |
431 "type": "object" | |
432 }, | |
433 "LatLng": { | |
434 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair\nof doubles representing degrees latitude and degrees
longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http
://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values
must be within normalized ranges.\n\nExample of normalization code in Python:\n
\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long
itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if
r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur
n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal
degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp
ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return
r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36
0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize
Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n
assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo
ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert
(0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali
zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\
n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.
0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng
(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as
sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N
ormalizeLatLng(-270.0, 10.0)", | |
435 "id": "LatLng", | |
436 "properties": { | |
437 "latitude": { | |
438 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", | |
439 "format": "double", | |
440 "type": "number" | |
441 }, | |
442 "longitude": { | |
443 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", | |
444 "format": "double", | |
445 "type": "number" | |
446 } | |
447 }, | |
448 "type": "object" | |
449 }, | |
450 "Key": { | |
451 "description": "A unique identifier for an entity.\nIf a key's parti
tion ID or any of its path kinds or names are\nreserved/read-only, the key is re
served/read-only.\nA reserved/read-only key is forbidden in certain documented c
ontexts.", | |
452 "id": "Key", | |
453 "properties": { | |
454 "path": { | |
455 "description": "The entity path.\nAn entity path consists of
one or more elements composed of a kind and a\nstring or numerical identifier,
which identify entities. The first\nelement identifies a _root entity_, the seco
nd element identifies\na _child_ of the root entity, the third element identifie
s a child of the\nsecond entity, and so forth. The entities identified by all pr
efixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is a
lways fully complete: *all* of the entity's ancestors\nare required to be in the
path along with the entity identifier itself.\nThe only exception is that in so
me documented cases, the identifier in the\nlast path element (for the entity) i
tself may be omitted. For example,\nthe last path element of the key of `Mutatio
n.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can
have at most 100 elements.", | |
456 "items": { | |
457 "$ref": "PathElement" | |
458 }, | |
459 "type": "array" | |
460 }, | |
461 "partitionId": { | |
462 "$ref": "PartitionId", | |
463 "description": "Entities are partitioned into subsets, curre
ntly identified by a project\nID and namespace ID.\nQueries are scoped to a sing
le partition." | |
464 } | |
465 }, | |
466 "type": "object" | |
467 }, | |
468 "PropertyReference": { | |
469 "description": "A reference to a property relative to the kind expre
ssions.", | |
470 "id": "PropertyReference", | |
471 "properties": { | |
472 "name": { | |
473 "description": "The name of the property.\nIf name includes
\".\"s, it may be interpreted as a property name path.", | |
474 "type": "string" | |
475 } | |
476 }, | |
477 "type": "object" | |
478 }, | |
479 "ArrayValue": { | |
480 "description": "An array value.", | |
481 "id": "ArrayValue", | |
482 "properties": { | |
483 "values": { | |
484 "description": "Values in the array.\nThe order of this arra
y may not be preserved if it contains a mix of\nindexed and unindexed values.", | |
485 "items": { | |
486 "$ref": "Value" | |
487 }, | |
488 "type": "array" | |
489 } | |
490 }, | |
491 "type": "object" | |
492 }, | |
493 "Projection": { | |
494 "description": "A representation of a property in a projection.", | |
495 "id": "Projection", | |
496 "properties": { | |
497 "property": { | |
498 "$ref": "PropertyReference", | |
499 "description": "The property to project." | |
500 } | |
501 }, | |
502 "type": "object" | |
503 }, | |
504 "Mutation": { | 411 "Mutation": { |
505 "description": "A mutation to apply to an entity.", | 412 "description": "A mutation to apply to an entity.", |
506 "id": "Mutation", | 413 "id": "Mutation", |
507 "properties": { | 414 "properties": { |
508 "delete": { | 415 "delete": { |
509 "$ref": "Key", | 416 "$ref": "Key", |
510 "description": "The key of the entity to delete. The entity
may or may not already exist.\nMust have a complete key path and must not be res
erved/read-only." | 417 "description": "The key of the entity to delete. The entity
may or may not already exist.\nMust have a complete key path and must not be res
erved/read-only." |
511 }, | 418 }, |
512 "baseVersion": { | 419 "baseVersion": { |
513 "description": "The version of the entity that this mutation
is being applied to. If this\ndoes not match the current version on the server,
the mutation conflicts.", | 420 "description": "The version of the entity that this mutation
is being applied to. If this\ndoes not match the current version on the server,
the mutation conflicts.", |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
554 } | 461 } |
555 }, | 462 }, |
556 "type": "object" | 463 "type": "object" |
557 }, | 464 }, |
558 "RollbackResponse": { | 465 "RollbackResponse": { |
559 "description": "The response for Datastore.Rollback.\n(an empty mess
age).", | 466 "description": "The response for Datastore.Rollback.\n(an empty mess
age).", |
560 "id": "RollbackResponse", | 467 "id": "RollbackResponse", |
561 "properties": {}, | 468 "properties": {}, |
562 "type": "object" | 469 "type": "object" |
563 }, | 470 }, |
| 471 "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { |
| 472 "description": "The response for\ngoogle.datastore.admin.v1beta1.Dat
astoreAdmin.ExportEntities.", |
| 473 "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse", |
| 474 "properties": { |
| 475 "outputUrl": { |
| 476 "description": "Location of the output metadata file. This c
an be used to begin an import\ninto Cloud Datastore (this project or another pro
ject). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnl
y present if the operation completed successfully.", |
| 477 "type": "string" |
| 478 } |
| 479 }, |
| 480 "type": "object" |
| 481 }, |
564 "MutationResult": { | 482 "MutationResult": { |
565 "description": "The result of applying a mutation.", | 483 "description": "The result of applying a mutation.", |
566 "id": "MutationResult", | 484 "id": "MutationResult", |
567 "properties": { | 485 "properties": { |
| 486 "conflictDetected": { |
| 487 "description": "Whether a conflict was detected for this mut
ation. Always false when a\nconflict detection strategy field is not set in the
mutation.", |
| 488 "type": "boolean" |
| 489 }, |
568 "key": { | 490 "key": { |
569 "$ref": "Key", | 491 "$ref": "Key", |
570 "description": "The automatically allocated key.\nSet only w
hen the mutation allocated a key." | 492 "description": "The automatically allocated key.\nSet only w
hen the mutation allocated a key." |
571 }, | 493 }, |
572 "version": { | 494 "version": { |
573 "description": "The version of the entity on the server afte
r processing the mutation. If\nthe mutation doesn't change anything on the serve
r, then the version will\nbe the version of the current entity or, if no entity
is present, a version\nthat is strictly greater than the version of any previous
entity and less\nthan the version of any possible future entity.", | 495 "description": "The version of the entity on the server afte
r processing the mutation. If\nthe mutation doesn't change anything on the serve
r, then the version will\nbe the version of the current entity or, if no entity
is present, a version\nthat is strictly greater than the version of any previous
entity and less\nthan the version of any possible future entity.", |
574 "format": "int64", | 496 "format": "int64", |
575 "type": "string" | 497 "type": "string" |
576 }, | |
577 "conflictDetected": { | |
578 "description": "Whether a conflict was detected for this mut
ation. Always false when a\nconflict detection strategy field is not set in the
mutation.", | |
579 "type": "boolean" | |
580 } | 498 } |
581 }, | 499 }, |
582 "type": "object" | 500 "type": "object" |
583 }, | 501 }, |
584 "GqlQuery": { | 502 "GqlQuery": { |
585 "description": "A [GQL query](https://cloud.google.com/datastore/doc
s/apis/gql/gql_reference).", | 503 "description": "A [GQL query](https://cloud.google.com/datastore/doc
s/apis/gql/gql_reference).", |
586 "id": "GqlQuery", | 504 "id": "GqlQuery", |
587 "properties": { | 505 "properties": { |
588 "queryString": { | 506 "queryString": { |
589 "description": "A string of the format described\n[here](htt
ps://cloud.google.com/datastore/docs/apis/gql/gql_reference).", | 507 "description": "A string of the format described\n[here](htt
ps://cloud.google.com/datastore/docs/apis/gql/gql_reference).", |
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
653 "$ref": "ReadOptions", | 571 "$ref": "ReadOptions", |
654 "description": "The options for this query." | 572 "description": "The options for this query." |
655 }, | 573 }, |
656 "query": { | 574 "query": { |
657 "$ref": "Query", | 575 "$ref": "Query", |
658 "description": "The query to run." | 576 "description": "The query to run." |
659 } | 577 } |
660 }, | 578 }, |
661 "type": "object" | 579 "type": "object" |
662 }, | 580 }, |
| 581 "Empty": { |
| 582 "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 `{}`.", |
| 583 "id": "Empty", |
| 584 "properties": {}, |
| 585 "type": "object" |
| 586 }, |
| 587 "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { |
| 588 "description": "Metadata for ExportEntities operations.", |
| 589 "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", |
| 590 "properties": { |
| 591 "common": { |
| 592 "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
| 593 "description": "Metadata common to all Datastore Admin opera
tions." |
| 594 }, |
| 595 "progressBytes": { |
| 596 "$ref": "GoogleDatastoreAdminV1beta1Progress", |
| 597 "description": "An estimate of the number of bytes processed
." |
| 598 }, |
| 599 "outputUrlPrefix": { |
| 600 "description": "Location for the export metadata and data fi
les. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportE
ntitiesRequest.output_url_prefix\nfield. The final output location is provided i
n\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", |
| 601 "type": "string" |
| 602 }, |
| 603 "entityFilter": { |
| 604 "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
| 605 "description": "Description of which entities are being expo
rted." |
| 606 }, |
| 607 "progressEntities": { |
| 608 "$ref": "GoogleDatastoreAdminV1beta1Progress", |
| 609 "description": "An estimate of the number of entities proces
sed." |
| 610 } |
| 611 }, |
| 612 "type": "object" |
| 613 }, |
| 614 "TransactionOptions": { |
| 615 "description": "Options for beginning a new transaction.\n\nTransact
ions can be created explicitly with calls to\nDatastore.BeginTransaction or impl
icitly by setting\nReadOptions.new_transaction in read requests.", |
| 616 "id": "TransactionOptions", |
| 617 "properties": { |
| 618 "readOnly": { |
| 619 "$ref": "ReadOnly", |
| 620 "description": "The transaction should only allow reads." |
| 621 }, |
| 622 "readWrite": { |
| 623 "$ref": "ReadWrite", |
| 624 "description": "The transaction should allow both reads and
writes." |
| 625 } |
| 626 }, |
| 627 "type": "object" |
| 628 }, |
663 "CompositeFilter": { | 629 "CompositeFilter": { |
664 "description": "A filter that merges multiple other filters using th
e given operator.", | 630 "description": "A filter that merges multiple other filters using th
e given operator.", |
665 "id": "CompositeFilter", | 631 "id": "CompositeFilter", |
666 "properties": { | 632 "properties": { |
667 "filters": { | |
668 "description": "The list of filters to combine.\nMust contai
n at least one filter.", | |
669 "items": { | |
670 "$ref": "Filter" | |
671 }, | |
672 "type": "array" | |
673 }, | |
674 "op": { | 633 "op": { |
675 "description": "The operator for combining multiple filters.
", | 634 "description": "The operator for combining multiple filters.
", |
676 "enum": [ | 635 "enum": [ |
677 "OPERATOR_UNSPECIFIED", | 636 "OPERATOR_UNSPECIFIED", |
678 "AND" | 637 "AND" |
679 ], | 638 ], |
680 "enumDescriptions": [ | 639 "enumDescriptions": [ |
681 "Unspecified. This value must not be used.", | 640 "Unspecified. This value must not be used.", |
682 "The results are required to satisfy each of the combine
d filters." | 641 "The results are required to satisfy each of the combine
d filters." |
683 ], | 642 ], |
684 "type": "string" | 643 "type": "string" |
| 644 }, |
| 645 "filters": { |
| 646 "description": "The list of filters to combine.\nMust contai
n at least one filter.", |
| 647 "items": { |
| 648 "$ref": "Filter" |
| 649 }, |
| 650 "type": "array" |
| 651 } |
| 652 }, |
| 653 "type": "object" |
| 654 }, |
| 655 "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { |
| 656 "description": "Metadata for ImportEntities operations.", |
| 657 "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", |
| 658 "properties": { |
| 659 "common": { |
| 660 "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
| 661 "description": "Metadata common to all Datastore Admin opera
tions." |
| 662 }, |
| 663 "inputUrl": { |
| 664 "description": "The location of the import metadata file. Th
is will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesR
esponse.output_url\nfield.", |
| 665 "type": "string" |
| 666 }, |
| 667 "progressBytes": { |
| 668 "$ref": "GoogleDatastoreAdminV1beta1Progress", |
| 669 "description": "An estimate of the number of bytes processed
." |
| 670 }, |
| 671 "entityFilter": { |
| 672 "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
| 673 "description": "Description of which entities are being impo
rted." |
| 674 }, |
| 675 "progressEntities": { |
| 676 "$ref": "GoogleDatastoreAdminV1beta1Progress", |
| 677 "description": "An estimate of the number of entities proces
sed." |
685 } | 678 } |
686 }, | 679 }, |
687 "type": "object" | 680 "type": "object" |
688 }, | 681 }, |
689 "AllocateIdsResponse": { | 682 "AllocateIdsResponse": { |
690 "description": "The response for Datastore.AllocateIds.", | 683 "description": "The response for Datastore.AllocateIds.", |
691 "id": "AllocateIdsResponse", | 684 "id": "AllocateIdsResponse", |
692 "properties": { | 685 "properties": { |
693 "keys": { | 686 "keys": { |
694 "description": "The keys specified in the request (in the sa
me order), each with\nits key path completed with a newly allocated ID.", | 687 "description": "The keys specified in the request (in the sa
me order), each with\nits key path completed with a newly allocated ID.", |
695 "items": { | 688 "items": { |
696 "$ref": "Key" | 689 "$ref": "Key" |
697 }, | 690 }, |
698 "type": "array" | 691 "type": "array" |
699 } | 692 } |
700 }, | 693 }, |
701 "type": "object" | 694 "type": "object" |
702 }, | 695 }, |
703 "Query": { | 696 "Query": { |
704 "description": "A query for entities.", | 697 "description": "A query for entities.", |
705 "id": "Query", | 698 "id": "Query", |
706 "properties": { | 699 "properties": { |
| 700 "filter": { |
| 701 "$ref": "Filter", |
| 702 "description": "The filter to apply." |
| 703 }, |
| 704 "limit": { |
| 705 "description": "The maximum number of results to return. App
lies after all other\nconstraints. Optional.\nUnspecified is interpreted as no l
imit.\nMust be >= 0 if specified.", |
| 706 "format": "int32", |
| 707 "type": "integer" |
| 708 }, |
| 709 "startCursor": { |
| 710 "description": "A starting point for the query results. Quer
y cursors are\nreturned in query result batches and\n[can only be used to contin
ue the same query](https://cloud.google.com/datastore/docs/concepts/queries#curs
ors_limits_and_offsets).", |
| 711 "format": "byte", |
| 712 "type": "string" |
| 713 }, |
| 714 "offset": { |
| 715 "description": "The number of results to skip. Applies befor
e limit, but after all other\nconstraints. Optional. Must be >= 0 if specified."
, |
| 716 "format": "int32", |
| 717 "type": "integer" |
| 718 }, |
707 "kind": { | 719 "kind": { |
708 "description": "The kinds to query (if empty, returns entiti
es of all kinds).\nCurrently at most 1 kind may be specified.", | 720 "description": "The kinds to query (if empty, returns entiti
es of all kinds).\nCurrently at most 1 kind may be specified.", |
709 "items": { | 721 "items": { |
710 "$ref": "KindExpression" | 722 "$ref": "KindExpression" |
711 }, | 723 }, |
712 "type": "array" | 724 "type": "array" |
713 }, | 725 }, |
714 "distinctOn": { | 726 "distinctOn": { |
715 "description": "The properties to make distinct. The query r
esults will contain the first\nresult for each distinct combination of values fo
r the given properties\n(if empty, all results are returned).", | 727 "description": "The properties to make distinct. The query r
esults will contain the first\nresult for each distinct combination of values fo
r the given properties\n(if empty, all results are returned).", |
716 "items": { | 728 "items": { |
(...skipping 12 matching lines...) Expand all Loading... |
729 "description": "The projection to return. Defaults to return
ing all properties.", | 741 "description": "The projection to return. Defaults to return
ing all properties.", |
730 "items": { | 742 "items": { |
731 "$ref": "Projection" | 743 "$ref": "Projection" |
732 }, | 744 }, |
733 "type": "array" | 745 "type": "array" |
734 }, | 746 }, |
735 "endCursor": { | 747 "endCursor": { |
736 "description": "An ending point for the query results. Query
cursors are\nreturned in query result batches and\n[can only be used to limit t
he same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_
limits_and_offsets).", | 748 "description": "An ending point for the query results. Query
cursors are\nreturned in query result batches and\n[can only be used to limit t
he same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_
limits_and_offsets).", |
737 "format": "byte", | 749 "format": "byte", |
738 "type": "string" | 750 "type": "string" |
739 }, | |
740 "limit": { | |
741 "description": "The maximum number of results to return. App
lies after all other\nconstraints. Optional.\nUnspecified is interpreted as no l
imit.\nMust be >= 0 if specified.", | |
742 "format": "int32", | |
743 "type": "integer" | |
744 }, | |
745 "filter": { | |
746 "$ref": "Filter", | |
747 "description": "The filter to apply." | |
748 }, | |
749 "offset": { | |
750 "description": "The number of results to skip. Applies befor
e limit, but after all other\nconstraints. Optional. Must be >= 0 if specified."
, | |
751 "format": "int32", | |
752 "type": "integer" | |
753 }, | |
754 "startCursor": { | |
755 "description": "A starting point for the query results. Quer
y cursors are\nreturned in query result batches and\n[can only be used to contin
ue the same query](https://cloud.google.com/datastore/docs/concepts/queries#curs
ors_limits_and_offsets).", | |
756 "format": "byte", | |
757 "type": "string" | |
758 } | 751 } |
759 }, | 752 }, |
760 "type": "object" | 753 "type": "object" |
761 }, | 754 }, |
| 755 "GoogleLongrunningOperation": { |
| 756 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 757 "id": "GoogleLongrunningOperation", |
| 758 "properties": { |
| 759 "error": { |
| 760 "$ref": "Status", |
| 761 "description": "The error result of the operation in case of
failure or cancellation." |
| 762 }, |
| 763 "metadata": { |
| 764 "additionalProperties": { |
| 765 "description": "Properties of the object. Contains field
@type with type URL.", |
| 766 "type": "any" |
| 767 }, |
| 768 "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.
", |
| 769 "type": "object" |
| 770 }, |
| 771 "done": { |
| 772 "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.", |
| 773 "type": "boolean" |
| 774 }, |
| 775 "response": { |
| 776 "additionalProperties": { |
| 777 "description": "Properties of the object. Contains field
@type with type URL.", |
| 778 "type": "any" |
| 779 }, |
| 780 "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`.", |
| 781 "type": "object" |
| 782 }, |
| 783 "name": { |
| 784 "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`
.", |
| 785 "type": "string" |
| 786 } |
| 787 }, |
| 788 "type": "object" |
| 789 }, |
| 790 "ReadOnly": { |
| 791 "description": "Options specific to read-only transactions.", |
| 792 "id": "ReadOnly", |
| 793 "properties": {}, |
| 794 "type": "object" |
| 795 }, |
762 "PropertyFilter": { | 796 "PropertyFilter": { |
763 "description": "A filter on a specific property.", | 797 "description": "A filter on a specific property.", |
764 "id": "PropertyFilter", | 798 "id": "PropertyFilter", |
765 "properties": { | 799 "properties": { |
766 "value": { | |
767 "$ref": "Value", | |
768 "description": "The value to compare the property to." | |
769 }, | |
770 "property": { | 800 "property": { |
771 "$ref": "PropertyReference", | 801 "$ref": "PropertyReference", |
772 "description": "The property to filter by." | 802 "description": "The property to filter by." |
773 }, | 803 }, |
774 "op": { | 804 "op": { |
775 "description": "The operator to filter by.", | 805 "description": "The operator to filter by.", |
776 "enum": [ | 806 "enum": [ |
777 "OPERATOR_UNSPECIFIED", | 807 "OPERATOR_UNSPECIFIED", |
778 "LESS_THAN", | 808 "LESS_THAN", |
779 "LESS_THAN_OR_EQUAL", | 809 "LESS_THAN_OR_EQUAL", |
780 "GREATER_THAN", | 810 "GREATER_THAN", |
781 "GREATER_THAN_OR_EQUAL", | 811 "GREATER_THAN_OR_EQUAL", |
782 "EQUAL", | 812 "EQUAL", |
783 "HAS_ANCESTOR" | 813 "HAS_ANCESTOR" |
784 ], | 814 ], |
785 "enumDescriptions": [ | 815 "enumDescriptions": [ |
786 "Unspecified. This value must not be used.", | 816 "Unspecified. This value must not be used.", |
787 "Less than.", | 817 "Less than.", |
788 "Less than or equal.", | 818 "Less than or equal.", |
789 "Greater than.", | 819 "Greater than.", |
790 "Greater than or equal.", | 820 "Greater than or equal.", |
791 "Equal.", | 821 "Equal.", |
792 "Has ancestor." | 822 "Has ancestor." |
793 ], | 823 ], |
794 "type": "string" | 824 "type": "string" |
| 825 }, |
| 826 "value": { |
| 827 "$ref": "Value", |
| 828 "description": "The value to compare the property to." |
795 } | 829 } |
796 }, | 830 }, |
797 "type": "object" | 831 "type": "object" |
798 }, | 832 }, |
799 "EntityResult": { | 833 "EntityResult": { |
800 "description": "The result of fetching an entity from Datastore.", | 834 "description": "The result of fetching an entity from Datastore.", |
801 "id": "EntityResult", | 835 "id": "EntityResult", |
802 "properties": { | 836 "properties": { |
803 "cursor": { | 837 "cursor": { |
804 "description": "A cursor that points to the position after t
he result entity.\nSet only when the `EntityResult` is part of a `QueryResultBat
ch` message.", | 838 "description": "A cursor that points to the position after t
he result entity.\nSet only when the `EntityResult` is part of a `QueryResultBat
ch` message.", |
805 "format": "byte", | 839 "format": "byte", |
806 "type": "string" | 840 "type": "string" |
807 }, | 841 }, |
808 "version": { | 842 "version": { |
809 "description": "The version of the entity, a strictly positi
ve number that monotonically\nincreases with changes to the entity.\n\nThis fiel
d is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`
, this\nis the version of the snapshot that was used to look up the entity, and
it\nis always set except for eventually consistent reads.", | 843 "description": "The version of the entity, a strictly positi
ve number that monotonically\nincreases with changes to the entity.\n\nThis fiel
d is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`
, this\nis the version of the snapshot that was used to look up the entity, and
it\nis always set except for eventually consistent reads.", |
810 "format": "int64", | 844 "format": "int64", |
811 "type": "string" | 845 "type": "string" |
812 }, | 846 }, |
813 "entity": { | 847 "entity": { |
814 "$ref": "Entity", | 848 "$ref": "Entity", |
815 "description": "The resulting entity." | 849 "description": "The resulting entity." |
816 } | 850 } |
817 }, | 851 }, |
818 "type": "object" | 852 "type": "object" |
819 }, | 853 }, |
820 "CommitResponse": { | |
821 "description": "The response for Datastore.Commit.", | |
822 "id": "CommitResponse", | |
823 "properties": { | |
824 "indexUpdates": { | |
825 "description": "The number of index entries updated during t
he commit, or zero if none were\nupdated.", | |
826 "format": "int32", | |
827 "type": "integer" | |
828 }, | |
829 "mutationResults": { | |
830 "description": "The result of performing the mutations.\nThe
i-th mutation result corresponds to the i-th mutation in the request.", | |
831 "items": { | |
832 "$ref": "MutationResult" | |
833 }, | |
834 "type": "array" | |
835 } | |
836 }, | |
837 "type": "object" | |
838 }, | |
839 "Value": { | 854 "Value": { |
840 "description": "A message that can hold any of the supported value t
ypes and associated\nmetadata.", | 855 "description": "A message that can hold any of the supported value t
ypes and associated\nmetadata.", |
841 "id": "Value", | 856 "id": "Value", |
842 "properties": { | 857 "properties": { |
843 "booleanValue": { | 858 "stringValue": { |
844 "description": "A boolean value.", | 859 "description": "A UTF-8 encoded string value.\nWhen `exclude
_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwis
e, may be set to at least 1,000,000 bytes.", |
| 860 "type": "string" |
| 861 }, |
| 862 "excludeFromIndexes": { |
| 863 "description": "If the value should be excluded from all ind
exes including those defined\nexplicitly.", |
845 "type": "boolean" | 864 "type": "boolean" |
846 }, | 865 }, |
| 866 "doubleValue": { |
| 867 "description": "A double value.", |
| 868 "format": "double", |
| 869 "type": "number" |
| 870 }, |
| 871 "timestampValue": { |
| 872 "description": "A timestamp value.\nWhen stored in the Datas
tore, precise only to microseconds;\nany additional precision is rounded down.", |
| 873 "format": "google-datetime", |
| 874 "type": "string" |
| 875 }, |
847 "nullValue": { | 876 "nullValue": { |
848 "description": "A null value.", | 877 "description": "A null value.", |
849 "enum": [ | 878 "enum": [ |
850 "NULL_VALUE" | 879 "NULL_VALUE" |
851 ], | 880 ], |
852 "enumDescriptions": [ | 881 "enumDescriptions": [ |
853 "Null value." | 882 "Null value." |
854 ], | 883 ], |
855 "type": "string" | 884 "type": "string" |
856 }, | 885 }, |
| 886 "booleanValue": { |
| 887 "description": "A boolean value.", |
| 888 "type": "boolean" |
| 889 }, |
857 "blobValue": { | 890 "blobValue": { |
858 "description": "A blob value.\nMay have at most 1,000,000 by
tes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSO
N requests, must be base64-encoded.", | 891 "description": "A blob value.\nMay have at most 1,000,000 by
tes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSO
N requests, must be base64-encoded.", |
859 "format": "byte", | 892 "format": "byte", |
860 "type": "string" | 893 "type": "string" |
861 }, | 894 }, |
862 "meaning": { | 895 "meaning": { |
863 "description": "The `meaning` field should only be populated
for backwards compatibility.", | 896 "description": "The `meaning` field should only be populated
for backwards compatibility.", |
864 "format": "int32", | 897 "format": "int32", |
865 "type": "integer" | 898 "type": "integer" |
866 }, | 899 }, |
867 "arrayValue": { | 900 "arrayValue": { |
868 "$ref": "ArrayValue", | 901 "$ref": "ArrayValue", |
869 "description": "An array value.\nCannot contain another arra
y value.\nA `Value` instance that sets field `array_value` must not set fields\n
`meaning` or `exclude_from_indexes`." | 902 "description": "An array value.\nCannot contain another arra
y value.\nA `Value` instance that sets field `array_value` must not set fields\n
`meaning` or `exclude_from_indexes`." |
870 }, | 903 }, |
871 "entityValue": { | 904 "entityValue": { |
872 "$ref": "Entity", | 905 "$ref": "Entity", |
873 "description": "An entity value.\n\n- May have no key.\n- Ma
y have a key with an incomplete key path.\n- May have a reserved/read-only key." | 906 "description": "An entity value.\n\n- May have no key.\n- Ma
y have a key with an incomplete key path.\n- May have a reserved/read-only key." |
874 }, | 907 }, |
875 "geoPointValue": { | 908 "geoPointValue": { |
876 "$ref": "LatLng", | 909 "$ref": "LatLng", |
877 "description": "A geo point value representing a point on th
e surface of Earth." | 910 "description": "A geo point value representing a point on th
e surface of Earth." |
878 }, | 911 }, |
| 912 "keyValue": { |
| 913 "$ref": "Key", |
| 914 "description": "A key value." |
| 915 }, |
879 "integerValue": { | 916 "integerValue": { |
880 "description": "An integer value.", | 917 "description": "An integer value.", |
881 "format": "int64", | 918 "format": "int64", |
882 "type": "string" | 919 "type": "string" |
883 }, | |
884 "keyValue": { | |
885 "$ref": "Key", | |
886 "description": "A key value." | |
887 }, | |
888 "stringValue": { | |
889 "description": "A UTF-8 encoded string value.\nWhen `exclude
_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwis
e, may be set to at least 1,000,000 bytes.", | |
890 "type": "string" | |
891 }, | |
892 "excludeFromIndexes": { | |
893 "description": "If the value should be excluded from all ind
exes including those defined\nexplicitly.", | |
894 "type": "boolean" | |
895 }, | |
896 "doubleValue": { | |
897 "description": "A double value.", | |
898 "format": "double", | |
899 "type": "number" | |
900 }, | |
901 "timestampValue": { | |
902 "description": "A timestamp value.\nWhen stored in the Datas
tore, precise only to microseconds;\nany additional precision is rounded down.", | |
903 "format": "google-datetime", | |
904 "type": "string" | |
905 } | 920 } |
906 }, | 921 }, |
907 "type": "object" | 922 "type": "object" |
| 923 }, |
| 924 "CommitResponse": { |
| 925 "description": "The response for Datastore.Commit.", |
| 926 "id": "CommitResponse", |
| 927 "properties": { |
| 928 "indexUpdates": { |
| 929 "description": "The number of index entries updated during t
he commit, or zero if none were\nupdated.", |
| 930 "format": "int32", |
| 931 "type": "integer" |
| 932 }, |
| 933 "mutationResults": { |
| 934 "description": "The result of performing the mutations.\nThe
i-th mutation result corresponds to the i-th mutation in the request.", |
| 935 "items": { |
| 936 "$ref": "MutationResult" |
| 937 }, |
| 938 "type": "array" |
| 939 } |
| 940 }, |
| 941 "type": "object" |
908 }, | 942 }, |
909 "PartitionId": { | 943 "PartitionId": { |
910 "description": "A partition ID identifies a grouping of entities. Th
e grouping is always\nby project and namespace, however the namespace ID may be
empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace
ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n
- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of
any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA
reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\
nForeign partition IDs (in which the project ID does\nnot match the context proj
ect ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if
the project is not in an active state.", | 944 "description": "A partition ID identifies a grouping of entities. Th
e grouping is always\nby project and namespace, however the namespace ID may be
empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace
ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n
- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of
any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA
reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\
nForeign partition IDs (in which the project ID does\nnot match the context proj
ect ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if
the project is not in an active state.", |
911 "id": "PartitionId", | 945 "id": "PartitionId", |
912 "properties": { | 946 "properties": { |
913 "namespaceId": { | 947 "namespaceId": { |
914 "description": "If not empty, the ID of the namespace to whi
ch the entities belong.", | 948 "description": "If not empty, the ID of the namespace to whi
ch the entities belong.", |
915 "type": "string" | 949 "type": "string" |
916 }, | 950 }, |
917 "projectId": { | 951 "projectId": { |
(...skipping 14 matching lines...) Expand all Loading... |
932 "properties": { | 966 "properties": { |
933 "additionalProperties": { | 967 "additionalProperties": { |
934 "$ref": "Value" | 968 "$ref": "Value" |
935 }, | 969 }, |
936 "description": "The entity's properties.\nThe map's keys are
property names.\nA property name matching regex `__.*__` is reserved.\nA reserv
ed property name is forbidden in certain documented contexts.\nThe name must not
contain more than 500 characters.\nThe name cannot be `\"\"`.", | 970 "description": "The entity's properties.\nThe map's keys are
property names.\nA property name matching regex `__.*__` is reserved.\nA reserv
ed property name is forbidden in certain documented contexts.\nThe name must not
contain more than 500 characters.\nThe name cannot be `\"\"`.", |
937 "type": "object" | 971 "type": "object" |
938 } | 972 } |
939 }, | 973 }, |
940 "type": "object" | 974 "type": "object" |
941 }, | 975 }, |
| 976 "ReadWrite": { |
| 977 "description": "Options specific to read / write transactions.", |
| 978 "id": "ReadWrite", |
| 979 "properties": { |
| 980 "previousTransaction": { |
| 981 "description": "The transaction identifier of the transactio
n being retried.", |
| 982 "format": "byte", |
| 983 "type": "string" |
| 984 } |
| 985 }, |
| 986 "type": "object" |
| 987 }, |
| 988 "GoogleDatastoreAdminV1beta1Progress": { |
| 989 "description": "Measures the progress of a particular metric.", |
| 990 "id": "GoogleDatastoreAdminV1beta1Progress", |
| 991 "properties": { |
| 992 "workEstimated": { |
| 993 "description": "An estimate of how much work needs to be per
formed. May be zero if the\nwork estimate is unavailable.", |
| 994 "format": "int64", |
| 995 "type": "string" |
| 996 }, |
| 997 "workCompleted": { |
| 998 "description": "Note that this may be greater than work_esti
mated.", |
| 999 "format": "int64", |
| 1000 "type": "string" |
| 1001 } |
| 1002 }, |
| 1003 "type": "object" |
| 1004 }, |
| 1005 "LookupRequest": { |
| 1006 "description": "The request for Datastore.Lookup.", |
| 1007 "id": "LookupRequest", |
| 1008 "properties": { |
| 1009 "readOptions": { |
| 1010 "$ref": "ReadOptions", |
| 1011 "description": "The options for this lookup request." |
| 1012 }, |
| 1013 "keys": { |
| 1014 "description": "Keys of entities to look up.", |
| 1015 "items": { |
| 1016 "$ref": "Key" |
| 1017 }, |
| 1018 "type": "array" |
| 1019 } |
| 1020 }, |
| 1021 "type": "object" |
| 1022 }, |
942 "QueryResultBatch": { | 1023 "QueryResultBatch": { |
943 "description": "A batch of results produced by a query.", | 1024 "description": "A batch of results produced by a query.", |
944 "id": "QueryResultBatch", | 1025 "id": "QueryResultBatch", |
945 "properties": { | 1026 "properties": { |
| 1027 "moreResults": { |
| 1028 "description": "The state of the query after the current bat
ch.", |
| 1029 "enum": [ |
| 1030 "MORE_RESULTS_TYPE_UNSPECIFIED", |
| 1031 "NOT_FINISHED", |
| 1032 "MORE_RESULTS_AFTER_LIMIT", |
| 1033 "MORE_RESULTS_AFTER_CURSOR", |
| 1034 "NO_MORE_RESULTS" |
| 1035 ], |
| 1036 "enumDescriptions": [ |
| 1037 "Unspecified. This value is never used.", |
| 1038 "There may be additional batches to fetch from this quer
y.", |
| 1039 "The query is finished, but there may be more results af
ter the limit.", |
| 1040 "The query is finished, but there may be more results af
ter the end\ncursor.", |
| 1041 "The query is finished, and there are no more results." |
| 1042 ], |
| 1043 "type": "string" |
| 1044 }, |
| 1045 "endCursor": { |
| 1046 "description": "A cursor that points to the position after t
he last result in the batch.", |
| 1047 "format": "byte", |
| 1048 "type": "string" |
| 1049 }, |
946 "snapshotVersion": { | 1050 "snapshotVersion": { |
947 "description": "The version number of the snapshot this batc
h was returned from.\nThis applies to the range of results from the query's `sta
rt_cursor` (or\nthe beginning of the query if no cursor was given) to this batch
's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, sub
sequent query result batches for the same query\ncan have a greater snapshot ver
sion number. Each batch's snapshot version\nis valid for all preceding batches.\
nThe value will be zero for eventually consistent queries.", | 1051 "description": "The version number of the snapshot this batc
h was returned from.\nThis applies to the range of results from the query's `sta
rt_cursor` (or\nthe beginning of the query if no cursor was given) to this batch
's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, sub
sequent query result batches for the same query\ncan have a greater snapshot ver
sion number. Each batch's snapshot version\nis valid for all preceding batches.\
nThe value will be zero for eventually consistent queries.", |
948 "format": "int64", | 1052 "format": "int64", |
949 "type": "string" | 1053 "type": "string" |
950 }, | 1054 }, |
951 "skippedCursor": { | 1055 "skippedCursor": { |
952 "description": "A cursor that points to the position after t
he last skipped result.\nWill be set when `skipped_results` != 0.", | 1056 "description": "A cursor that points to the position after t
he last skipped result.\nWill be set when `skipped_results` != 0.", |
953 "format": "byte", | 1057 "format": "byte", |
954 "type": "string" | 1058 "type": "string" |
955 }, | 1059 }, |
(...skipping 17 matching lines...) Expand all Loading... |
973 "Only the key." | 1077 "Only the key." |
974 ], | 1078 ], |
975 "type": "string" | 1079 "type": "string" |
976 }, | 1080 }, |
977 "entityResults": { | 1081 "entityResults": { |
978 "description": "The results for this batch.", | 1082 "description": "The results for this batch.", |
979 "items": { | 1083 "items": { |
980 "$ref": "EntityResult" | 1084 "$ref": "EntityResult" |
981 }, | 1085 }, |
982 "type": "array" | 1086 "type": "array" |
983 }, | |
984 "endCursor": { | |
985 "description": "A cursor that points to the position after t
he last result in the batch.", | |
986 "format": "byte", | |
987 "type": "string" | |
988 }, | |
989 "moreResults": { | |
990 "description": "The state of the query after the current bat
ch.", | |
991 "enum": [ | |
992 "MORE_RESULTS_TYPE_UNSPECIFIED", | |
993 "NOT_FINISHED", | |
994 "MORE_RESULTS_AFTER_LIMIT", | |
995 "MORE_RESULTS_AFTER_CURSOR", | |
996 "NO_MORE_RESULTS" | |
997 ], | |
998 "enumDescriptions": [ | |
999 "Unspecified. This value is never used.", | |
1000 "There may be additional batches to fetch from this quer
y.", | |
1001 "The query is finished, but there may be more results af
ter the limit.", | |
1002 "The query is finished, but there may be more results af
ter the end\ncursor.", | |
1003 "The query is finished, and there are no more results." | |
1004 ], | |
1005 "type": "string" | |
1006 } | 1087 } |
1007 }, | 1088 }, |
1008 "type": "object" | 1089 "type": "object" |
1009 }, | |
1010 "LookupRequest": { | |
1011 "description": "The request for Datastore.Lookup.", | |
1012 "id": "LookupRequest", | |
1013 "properties": { | |
1014 "keys": { | |
1015 "description": "Keys of entities to look up.", | |
1016 "items": { | |
1017 "$ref": "Key" | |
1018 }, | |
1019 "type": "array" | |
1020 }, | |
1021 "readOptions": { | |
1022 "$ref": "ReadOptions", | |
1023 "description": "The options for this lookup request." | |
1024 } | |
1025 }, | |
1026 "type": "object" | |
1027 }, | 1090 }, |
1028 "PathElement": { | 1091 "PathElement": { |
1029 "description": "A (kind, ID/name) pair used to construct a key path.
\n\nIf either name or ID is set, the element is complete.\nIf neither is set, th
e element is incomplete.", | 1092 "description": "A (kind, ID/name) pair used to construct a key path.
\n\nIf either name or ID is set, the element is complete.\nIf neither is set, th
e element is incomplete.", |
1030 "id": "PathElement", | 1093 "id": "PathElement", |
1031 "properties": { | 1094 "properties": { |
1032 "id": { | |
1033 "description": "The auto-allocated ID of the entity.\nNever
equal to zero. Values less than zero are discouraged and may not\nbe supported i
n the future.", | |
1034 "format": "int64", | |
1035 "type": "string" | |
1036 }, | |
1037 "name": { | 1095 "name": { |
1038 "description": "The name of the entity.\nA name matching reg
ex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when
UTF-8 encoded.\nCannot be `\"\"`.", | 1096 "description": "The name of the entity.\nA name matching reg
ex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when
UTF-8 encoded.\nCannot be `\"\"`.", |
1039 "type": "string" | 1097 "type": "string" |
1040 }, | 1098 }, |
1041 "kind": { | 1099 "kind": { |
1042 "description": "The kind of the entity.\nA kind matching reg
ex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes
when UTF-8 encoded.\nCannot be `\"\"`.", | 1100 "description": "The kind of the entity.\nA kind matching reg
ex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes
when UTF-8 encoded.\nCannot be `\"\"`.", |
1043 "type": "string" | 1101 "type": "string" |
| 1102 }, |
| 1103 "id": { |
| 1104 "description": "The auto-allocated ID of the entity.\nNever
equal to zero. Values less than zero are discouraged and may not\nbe supported i
n the future.", |
| 1105 "format": "int64", |
| 1106 "type": "string" |
| 1107 } |
| 1108 }, |
| 1109 "type": "object" |
| 1110 }, |
| 1111 "Status": { |
| 1112 "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.", |
| 1113 "id": "Status", |
| 1114 "properties": { |
| 1115 "code": { |
| 1116 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1117 "format": "int32", |
| 1118 "type": "integer" |
| 1119 }, |
| 1120 "message": { |
| 1121 "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.", |
| 1122 "type": "string" |
| 1123 }, |
| 1124 "details": { |
| 1125 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 1126 "items": { |
| 1127 "additionalProperties": { |
| 1128 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1129 "type": "any" |
| 1130 }, |
| 1131 "type": "object" |
| 1132 }, |
| 1133 "type": "array" |
1044 } | 1134 } |
1045 }, | 1135 }, |
1046 "type": "object" | 1136 "type": "object" |
1047 }, | 1137 }, |
1048 "GqlQueryParameter": { | 1138 "GqlQueryParameter": { |
1049 "description": "A binding parameter for a GQL query.", | 1139 "description": "A binding parameter for a GQL query.", |
1050 "id": "GqlQueryParameter", | 1140 "id": "GqlQueryParameter", |
1051 "properties": { | 1141 "properties": { |
| 1142 "cursor": { |
| 1143 "description": "A query cursor. Query cursors are returned i
n query\nresult batches.", |
| 1144 "format": "byte", |
| 1145 "type": "string" |
| 1146 }, |
1052 "value": { | 1147 "value": { |
1053 "$ref": "Value", | 1148 "$ref": "Value", |
1054 "description": "A value parameter." | 1149 "description": "A value parameter." |
1055 }, | 1150 } |
1056 "cursor": { | 1151 }, |
1057 "description": "A query cursor. Query cursors are returned i
n query\nresult batches.", | 1152 "type": "object" |
| 1153 }, |
| 1154 "GoogleLongrunningListOperationsResponse": { |
| 1155 "description": "The response message for Operations.ListOperations."
, |
| 1156 "id": "GoogleLongrunningListOperationsResponse", |
| 1157 "properties": { |
| 1158 "operations": { |
| 1159 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 1160 "items": { |
| 1161 "$ref": "GoogleLongrunningOperation" |
| 1162 }, |
| 1163 "type": "array" |
| 1164 }, |
| 1165 "nextPageToken": { |
| 1166 "description": "The standard List next-page token.", |
| 1167 "type": "string" |
| 1168 } |
| 1169 }, |
| 1170 "type": "object" |
| 1171 }, |
| 1172 "BeginTransactionResponse": { |
| 1173 "description": "The response for Datastore.BeginTransaction.", |
| 1174 "id": "BeginTransactionResponse", |
| 1175 "properties": { |
| 1176 "transaction": { |
| 1177 "description": "The transaction identifier (always present).
", |
1058 "format": "byte", | 1178 "format": "byte", |
1059 "type": "string" | 1179 "type": "string" |
1060 } | 1180 } |
1061 }, | 1181 }, |
1062 "type": "object" | 1182 "type": "object" |
| 1183 }, |
| 1184 "AllocateIdsRequest": { |
| 1185 "description": "The request for Datastore.AllocateIds.", |
| 1186 "id": "AllocateIdsRequest", |
| 1187 "properties": { |
| 1188 "keys": { |
| 1189 "description": "A list of keys with incomplete key paths for
which to allocate IDs.\nNo key may be reserved/read-only.", |
| 1190 "items": { |
| 1191 "$ref": "Key" |
| 1192 }, |
| 1193 "type": "array" |
| 1194 } |
| 1195 }, |
| 1196 "type": "object" |
| 1197 }, |
| 1198 "RunQueryResponse": { |
| 1199 "description": "The response for Datastore.RunQuery.", |
| 1200 "id": "RunQueryResponse", |
| 1201 "properties": { |
| 1202 "query": { |
| 1203 "$ref": "Query", |
| 1204 "description": "The parsed form of the `GqlQuery` from the r
equest, if it was set." |
| 1205 }, |
| 1206 "batch": { |
| 1207 "$ref": "QueryResultBatch", |
| 1208 "description": "A batch of query results (always present)." |
| 1209 } |
| 1210 }, |
| 1211 "type": "object" |
| 1212 }, |
| 1213 "LookupResponse": { |
| 1214 "description": "The response for Datastore.Lookup.", |
| 1215 "id": "LookupResponse", |
| 1216 "properties": { |
| 1217 "deferred": { |
| 1218 "description": "A list of keys that were not looked up due t
o resource constraints. The\norder of results in this field is undefined and has
no relation to the\norder of the keys in the input.", |
| 1219 "items": { |
| 1220 "$ref": "Key" |
| 1221 }, |
| 1222 "type": "array" |
| 1223 }, |
| 1224 "missing": { |
| 1225 "description": "Entities not found as `ResultType.KEY_ONLY`
entities. The order of results\nin this field is undefined and has no relation t
o the order of the keys\nin the input.", |
| 1226 "items": { |
| 1227 "$ref": "EntityResult" |
| 1228 }, |
| 1229 "type": "array" |
| 1230 }, |
| 1231 "found": { |
| 1232 "description": "Entities found as `ResultType.FULL` entities
. The order of results in this\nfield is undefined and has no relation to the or
der of the keys in the\ninput.", |
| 1233 "items": { |
| 1234 "$ref": "EntityResult" |
| 1235 }, |
| 1236 "type": "array" |
| 1237 } |
| 1238 }, |
| 1239 "type": "object" |
| 1240 }, |
| 1241 "CommitRequest": { |
| 1242 "description": "The request for Datastore.Commit.", |
| 1243 "id": "CommitRequest", |
| 1244 "properties": { |
| 1245 "transaction": { |
| 1246 "description": "The identifier of the transaction associated
with the commit. A\ntransaction identifier is returned by a call to\nDatastore.
BeginTransaction.", |
| 1247 "format": "byte", |
| 1248 "type": "string" |
| 1249 }, |
| 1250 "mode": { |
| 1251 "description": "The type of commit to perform. Defaults to `
TRANSACTIONAL`.", |
| 1252 "enum": [ |
| 1253 "MODE_UNSPECIFIED", |
| 1254 "TRANSACTIONAL", |
| 1255 "NON_TRANSACTIONAL" |
| 1256 ], |
| 1257 "enumDescriptions": [ |
| 1258 "Unspecified. This value must not be used.", |
| 1259 "Transactional: The mutations are either all applied, or
none are applied.\nLearn about transactions [here](https://cloud.google.com/dat
astore/docs/concepts/transactions).", |
| 1260 "Non-transactional: The mutations may not apply as all o
r none." |
| 1261 ], |
| 1262 "type": "string" |
| 1263 }, |
| 1264 "mutations": { |
| 1265 "description": "The mutations to perform.\n\nWhen mode is `T
RANSACTIONAL`, mutations affecting a single entity are\napplied in order. The fo
llowing sequences of mutations affecting a single\nentity are not permitted in a
single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followe
d by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\
n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentit
y.", |
| 1266 "items": { |
| 1267 "$ref": "Mutation" |
| 1268 }, |
| 1269 "type": "array" |
| 1270 } |
| 1271 }, |
| 1272 "type": "object" |
| 1273 }, |
| 1274 "BeginTransactionRequest": { |
| 1275 "description": "The request for Datastore.BeginTransaction.", |
| 1276 "id": "BeginTransactionRequest", |
| 1277 "properties": { |
| 1278 "transactionOptions": { |
| 1279 "$ref": "TransactionOptions", |
| 1280 "description": "Options for a new transaction." |
| 1281 } |
| 1282 }, |
| 1283 "type": "object" |
| 1284 }, |
| 1285 "PropertyOrder": { |
| 1286 "description": "The desired order for a specific property.", |
| 1287 "id": "PropertyOrder", |
| 1288 "properties": { |
| 1289 "direction": { |
| 1290 "description": "The direction to order by. Defaults to `ASCE
NDING`.", |
| 1291 "enum": [ |
| 1292 "DIRECTION_UNSPECIFIED", |
| 1293 "ASCENDING", |
| 1294 "DESCENDING" |
| 1295 ], |
| 1296 "enumDescriptions": [ |
| 1297 "Unspecified. This value must not be used.", |
| 1298 "Ascending.", |
| 1299 "Descending." |
| 1300 ], |
| 1301 "type": "string" |
| 1302 }, |
| 1303 "property": { |
| 1304 "$ref": "PropertyReference", |
| 1305 "description": "The property to order by." |
| 1306 } |
| 1307 }, |
| 1308 "type": "object" |
| 1309 }, |
| 1310 "KindExpression": { |
| 1311 "description": "A representation of a kind.", |
| 1312 "id": "KindExpression", |
| 1313 "properties": { |
| 1314 "name": { |
| 1315 "description": "The name of the kind.", |
| 1316 "type": "string" |
| 1317 } |
| 1318 }, |
| 1319 "type": "object" |
| 1320 }, |
| 1321 "LatLng": { |
| 1322 "description": "An object representing a latitude/longitude pair. Th
is is expressed as a pair\nof doubles representing degrees latitude and degrees
longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http
://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values
must be within normalized ranges.\n\nExample of normalization code in Python:\n
\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long
itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if
r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur
n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal
degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp
ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return
r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36
0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize
Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n
assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo
ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert
(0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali
zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\
n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.
0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng
(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as
sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N
ormalizeLatLng(-270.0, 10.0)", |
| 1323 "id": "LatLng", |
| 1324 "properties": { |
| 1325 "latitude": { |
| 1326 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", |
| 1327 "format": "double", |
| 1328 "type": "number" |
| 1329 }, |
| 1330 "longitude": { |
| 1331 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", |
| 1332 "format": "double", |
| 1333 "type": "number" |
| 1334 } |
| 1335 }, |
| 1336 "type": "object" |
| 1337 }, |
| 1338 "Key": { |
| 1339 "description": "A unique identifier for an entity.\nIf a key's parti
tion ID or any of its path kinds or names are\nreserved/read-only, the key is re
served/read-only.\nA reserved/read-only key is forbidden in certain documented c
ontexts.", |
| 1340 "id": "Key", |
| 1341 "properties": { |
| 1342 "path": { |
| 1343 "description": "The entity path.\nAn entity path consists of
one or more elements composed of a kind and a\nstring or numerical identifier,
which identify entities. The first\nelement identifies a _root entity_, the seco
nd element identifies\na _child_ of the root entity, the third element identifie
s a child of the\nsecond entity, and so forth. The entities identified by all pr
efixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is a
lways fully complete: *all* of the entity's ancestors\nare required to be in the
path along with the entity identifier itself.\nThe only exception is that in so
me documented cases, the identifier in the\nlast path element (for the entity) i
tself may be omitted. For example,\nthe last path element of the key of `Mutatio
n.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can
have at most 100 elements.", |
| 1344 "items": { |
| 1345 "$ref": "PathElement" |
| 1346 }, |
| 1347 "type": "array" |
| 1348 }, |
| 1349 "partitionId": { |
| 1350 "$ref": "PartitionId", |
| 1351 "description": "Entities are partitioned into subsets, curre
ntly identified by a project\nID and namespace ID.\nQueries are scoped to a sing
le partition." |
| 1352 } |
| 1353 }, |
| 1354 "type": "object" |
| 1355 }, |
| 1356 "PropertyReference": { |
| 1357 "description": "A reference to a property relative to the kind expre
ssions.", |
| 1358 "id": "PropertyReference", |
| 1359 "properties": { |
| 1360 "name": { |
| 1361 "description": "The name of the property.\nIf name includes
\".\"s, it may be interpreted as a property name path.", |
| 1362 "type": "string" |
| 1363 } |
| 1364 }, |
| 1365 "type": "object" |
| 1366 }, |
| 1367 "GoogleDatastoreAdminV1beta1EntityFilter": { |
| 1368 "description": "Identifies a subset of entities in a project. This
is specified as\ncombinations of kind + namespace (either or both of which may b
e all, as\ndescribed in the following examples).\nExample usage:\n\nEntire proje
ct:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kin
ds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default nam
espace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both
the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Ba
z']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", |
| 1369 "id": "GoogleDatastoreAdminV1beta1EntityFilter", |
| 1370 "properties": { |
| 1371 "kinds": { |
| 1372 "description": "If empty, then this represents all kinds.", |
| 1373 "items": { |
| 1374 "type": "string" |
| 1375 }, |
| 1376 "type": "array" |
| 1377 }, |
| 1378 "namespaceIds": { |
| 1379 "description": "An empty list represents all namespaces. Th
is is the preferred\nusage for projects that don't use namespaces.\n\nAn empty s
tring element represents the default namespace. This should be\nused if the pro
ject has data in non-default namespaces, but doesn't want to\ninclude them.\nEac
h namespace in this list must be unique.", |
| 1380 "items": { |
| 1381 "type": "string" |
| 1382 }, |
| 1383 "type": "array" |
| 1384 } |
| 1385 }, |
| 1386 "type": "object" |
| 1387 }, |
| 1388 "GoogleDatastoreAdminV1beta1CommonMetadata": { |
| 1389 "description": "Metadata common to all Datastore Admin operations.", |
| 1390 "id": "GoogleDatastoreAdminV1beta1CommonMetadata", |
| 1391 "properties": { |
| 1392 "labels": { |
| 1393 "additionalProperties": { |
| 1394 "type": "string" |
| 1395 }, |
| 1396 "description": "The client-assigned labels which were provid
ed when the operation was\ncreated. May also include additional labels.", |
| 1397 "type": "object" |
| 1398 }, |
| 1399 "endTime": { |
| 1400 "description": "The time the operation ended, either success
fully or otherwise.", |
| 1401 "format": "google-datetime", |
| 1402 "type": "string" |
| 1403 }, |
| 1404 "state": { |
| 1405 "description": "The current state of the Operation.", |
| 1406 "enum": [ |
| 1407 "STATE_UNSPECIFIED", |
| 1408 "INITIALIZING", |
| 1409 "PROCESSING", |
| 1410 "CANCELLING", |
| 1411 "FINALIZING", |
| 1412 "SUCCESSFUL", |
| 1413 "FAILED", |
| 1414 "CANCELLED" |
| 1415 ], |
| 1416 "enumDescriptions": [ |
| 1417 "Unspecified.", |
| 1418 "Request is being prepared for processing.", |
| 1419 "Request is actively being processed.", |
| 1420 "Request is in the process of being cancelled after user
called\nlongrunning.Operations.CancelOperation on the operation.", |
| 1421 "Request has been processed and is in its finalization s
tage.", |
| 1422 "Request has completed successfully.", |
| 1423 "Request has finished being processed, but encountered a
n error.", |
| 1424 "Request has finished being cancelled after user called\
nlongrunning.Operations.CancelOperation." |
| 1425 ], |
| 1426 "type": "string" |
| 1427 }, |
| 1428 "operationType": { |
| 1429 "description": "The type of the operation. Can be used as a
filter in\nListOperationsRequest.", |
| 1430 "enum": [ |
| 1431 "OPERATION_TYPE_UNSPECIFIED", |
| 1432 "EXPORT_ENTITIES", |
| 1433 "IMPORT_ENTITIES", |
| 1434 "BUILD_INDEX", |
| 1435 "CLEAR_INDEX" |
| 1436 ], |
| 1437 "enumDescriptions": [ |
| 1438 "Unspecified.", |
| 1439 "ExportEntities.", |
| 1440 "ImportEntities.", |
| 1441 "Build an index.", |
| 1442 "Clear an index." |
| 1443 ], |
| 1444 "type": "string" |
| 1445 }, |
| 1446 "startTime": { |
| 1447 "description": "The time that work began on the operation.", |
| 1448 "format": "google-datetime", |
| 1449 "type": "string" |
| 1450 } |
| 1451 }, |
| 1452 "type": "object" |
| 1453 }, |
| 1454 "Projection": { |
| 1455 "description": "A representation of a property in a projection.", |
| 1456 "id": "Projection", |
| 1457 "properties": { |
| 1458 "property": { |
| 1459 "$ref": "PropertyReference", |
| 1460 "description": "The property to project." |
| 1461 } |
| 1462 }, |
| 1463 "type": "object" |
| 1464 }, |
| 1465 "ArrayValue": { |
| 1466 "description": "An array value.", |
| 1467 "id": "ArrayValue", |
| 1468 "properties": { |
| 1469 "values": { |
| 1470 "description": "Values in the array.\nThe order of this arra
y may not be preserved if it contains a mix of\nindexed and unindexed values.", |
| 1471 "items": { |
| 1472 "$ref": "Value" |
| 1473 }, |
| 1474 "type": "array" |
| 1475 } |
| 1476 }, |
| 1477 "type": "object" |
1063 } | 1478 } |
1064 }, | 1479 }, |
1065 "servicePath": "", | 1480 "servicePath": "", |
1066 "title": "Google Cloud Datastore API", | 1481 "title": "Google Cloud Datastore API", |
1067 "version": "v1" | 1482 "version": "v1" |
1068 } | 1483 } |
OLD | NEW |