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 "alt": { | 30 "bearer_token": { |
31 "default": "json", | 31 "description": "OAuth bearer token.", |
32 "description": "Data format for response.", | |
33 "enum": [ | |
34 "json", | |
35 "media", | |
36 "proto" | |
37 ], | |
38 "enumDescriptions": [ | |
39 "Responses with Content-Type of application/json", | |
40 "Media download with context-dependent Content-Type", | |
41 "Responses with Content-Type of application/x-protobuf" | |
42 ], | |
43 "location": "query", | 32 "location": "query", |
44 "type": "string" | 33 "type": "string" |
45 }, | 34 }, |
46 "key": { | |
47 "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.", | |
48 "location": "query", | |
49 "type": "string" | |
50 }, | |
51 "access_token": { | |
52 "description": "OAuth access token.", | |
53 "location": "query", | |
54 "type": "string" | |
55 }, | |
56 "quotaUser": { | |
57 "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.", | |
58 "location": "query", | |
59 "type": "string" | |
60 }, | |
61 "pp": { | |
62 "default": "true", | |
63 "description": "Pretty-print response.", | |
64 "location": "query", | |
65 "type": "boolean" | |
66 }, | |
67 "oauth_token": { | 35 "oauth_token": { |
68 "description": "OAuth 2.0 token for the current user.", | 36 "description": "OAuth 2.0 token for the current user.", |
69 "location": "query", | 37 "location": "query", |
70 "type": "string" | 38 "type": "string" |
71 }, | 39 }, |
72 "bearer_token": { | |
73 "description": "OAuth bearer token.", | |
74 "location": "query", | |
75 "type": "string" | |
76 }, | |
77 "upload_protocol": { | 40 "upload_protocol": { |
78 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
79 "location": "query", | 42 "location": "query", |
80 "type": "string" | 43 "type": "string" |
81 }, | 44 }, |
82 "prettyPrint": { | 45 "prettyPrint": { |
83 "default": "true", | 46 "default": "true", |
84 "description": "Returns response with indentations and line breaks."
, | 47 "description": "Returns response with indentations and line breaks."
, |
85 "location": "query", | 48 "location": "query", |
86 "type": "boolean" | 49 "type": "boolean" |
87 }, | 50 }, |
88 "uploadType": { | 51 "uploadType": { |
89 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 52 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
90 "location": "query", | 53 "location": "query", |
91 "type": "string" | 54 "type": "string" |
92 }, | 55 }, |
93 "fields": { | 56 "fields": { |
94 "description": "Selector specifying which fields to include in a par
tial response.", | 57 "description": "Selector specifying which fields to include in a par
tial response.", |
95 "location": "query", | 58 "location": "query", |
96 "type": "string" | 59 "type": "string" |
97 }, | 60 }, |
98 "callback": { | |
99 "description": "JSONP", | |
100 "location": "query", | |
101 "type": "string" | |
102 }, | |
103 "$.xgafv": { | 61 "$.xgafv": { |
104 "description": "V1 error format.", | 62 "description": "V1 error format.", |
105 "enum": [ | 63 "enum": [ |
106 "1", | 64 "1", |
107 "2" | 65 "2" |
108 ], | 66 ], |
109 "enumDescriptions": [ | 67 "enumDescriptions": [ |
110 "v1 error format", | 68 "v1 error format", |
111 "v2 error format" | 69 "v2 error format" |
112 ], | 70 ], |
113 "location": "query", | 71 "location": "query", |
114 "type": "string" | 72 "type": "string" |
| 73 }, |
| 74 "callback": { |
| 75 "description": "JSONP", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "alt": { |
| 80 "default": "json", |
| 81 "description": "Data format for response.", |
| 82 "enum": [ |
| 83 "json", |
| 84 "media", |
| 85 "proto" |
| 86 ], |
| 87 "enumDescriptions": [ |
| 88 "Responses with Content-Type of application/json", |
| 89 "Media download with context-dependent Content-Type", |
| 90 "Responses with Content-Type of application/x-protobuf" |
| 91 ], |
| 92 "location": "query", |
| 93 "type": "string" |
| 94 }, |
| 95 "access_token": { |
| 96 "description": "OAuth access token.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 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": { |
| 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", |
| 108 "type": "string" |
| 109 }, |
| 110 "pp": { |
| 111 "default": "true", |
| 112 "description": "Pretty-print response.", |
| 113 "location": "query", |
| 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 "allocateIds": { | |
122 "description": "Allocates IDs for the given keys, which is u
seful for referencing an entity\nbefore it is inserted.", | |
123 "httpMethod": "POST", | |
124 "id": "datastore.projects.allocateIds", | |
125 "parameterOrder": [ | |
126 "projectId" | |
127 ], | |
128 "parameters": { | |
129 "projectId": { | |
130 "description": "The ID of the project against which
to make the request.", | |
131 "location": "path", | |
132 "required": true, | |
133 "type": "string" | |
134 } | |
135 }, | |
136 "path": "v1/projects/{projectId}:allocateIds", | |
137 "request": { | |
138 "$ref": "AllocateIdsRequest" | |
139 }, | |
140 "response": { | |
141 "$ref": "AllocateIdsResponse" | |
142 }, | |
143 "scopes": [ | |
144 "https://www.googleapis.com/auth/cloud-platform", | |
145 "https://www.googleapis.com/auth/datastore" | |
146 ] | |
147 }, | |
148 "beginTransaction": { | 121 "beginTransaction": { |
149 "description": "Begins a new transaction.", | 122 "description": "Begins a new transaction.", |
150 "httpMethod": "POST", | 123 "httpMethod": "POST", |
151 "id": "datastore.projects.beginTransaction", | 124 "id": "datastore.projects.beginTransaction", |
152 "parameterOrder": [ | 125 "parameterOrder": [ |
153 "projectId" | 126 "projectId" |
154 ], | 127 ], |
155 "parameters": { | 128 "parameters": { |
156 "projectId": { | 129 "projectId": { |
157 "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.", |
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
272 "request": { | 245 "request": { |
273 "$ref": "LookupRequest" | 246 "$ref": "LookupRequest" |
274 }, | 247 }, |
275 "response": { | 248 "response": { |
276 "$ref": "LookupResponse" | 249 "$ref": "LookupResponse" |
277 }, | 250 }, |
278 "scopes": [ | 251 "scopes": [ |
279 "https://www.googleapis.com/auth/cloud-platform", | 252 "https://www.googleapis.com/auth/cloud-platform", |
280 "https://www.googleapis.com/auth/datastore" | 253 "https://www.googleapis.com/auth/datastore" |
281 ] | 254 ] |
| 255 }, |
| 256 "allocateIds": { |
| 257 "description": "Allocates IDs for the given keys, which is u
seful for referencing an entity\nbefore it is inserted.", |
| 258 "httpMethod": "POST", |
| 259 "id": "datastore.projects.allocateIds", |
| 260 "parameterOrder": [ |
| 261 "projectId" |
| 262 ], |
| 263 "parameters": { |
| 264 "projectId": { |
| 265 "description": "The ID of the project against which
to make the request.", |
| 266 "location": "path", |
| 267 "required": true, |
| 268 "type": "string" |
| 269 } |
| 270 }, |
| 271 "path": "v1/projects/{projectId}:allocateIds", |
| 272 "request": { |
| 273 "$ref": "AllocateIdsRequest" |
| 274 }, |
| 275 "response": { |
| 276 "$ref": "AllocateIdsResponse" |
| 277 }, |
| 278 "scopes": [ |
| 279 "https://www.googleapis.com/auth/cloud-platform", |
| 280 "https://www.googleapis.com/auth/datastore" |
| 281 ] |
282 } | 282 } |
283 } | 283 } |
284 } | 284 } |
285 }, | 285 }, |
286 "revision": "20170626", | 286 "revision": "20170711", |
287 "rootUrl": "https://datastore.googleapis.com/", | 287 "rootUrl": "https://datastore.googleapis.com/", |
288 "schemas": { | 288 "schemas": { |
289 "AllocateIdsResponse": { | 289 "BeginTransactionResponse": { |
290 "description": "The response for Datastore.AllocateIds.", | 290 "description": "The response for Datastore.BeginTransaction.", |
291 "id": "AllocateIdsResponse", | 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", |
292 "properties": { | 304 "properties": { |
293 "keys": { | 305 "keys": { |
294 "description": "The keys specified in the request (in the sa
me order), each with\nits key path completed with a newly allocated ID.", | 306 "description": "A list of keys with incomplete key paths for
which to allocate IDs.\nNo key may be reserved/read-only.", |
295 "items": { | 307 "items": { |
296 "$ref": "Key" | 308 "$ref": "Key" |
297 }, | 309 }, |
298 "type": "array" | 310 "type": "array" |
299 } | 311 } |
300 }, | 312 }, |
301 "type": "object" | 313 "type": "object" |
302 }, | 314 }, |
303 "Query": { | 315 "LookupResponse": { |
304 "description": "A query for entities.", | 316 "description": "The response for Datastore.Lookup.", |
305 "id": "Query", | 317 "id": "LookupResponse", |
306 "properties": { | 318 "properties": { |
307 "projection": { | 319 "deferred": { |
308 "description": "The projection to return. Defaults to return
ing all properties.", | 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.", |
309 "items": { | 321 "items": { |
310 "$ref": "Projection" | 322 "$ref": "Key" |
311 }, | 323 }, |
312 "type": "array" | 324 "type": "array" |
313 }, | 325 }, |
314 "endCursor": { | 326 "missing": { |
315 "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).", | 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.", |
316 "format": "byte", | 385 "format": "byte", |
317 "type": "string" | 386 "type": "string" |
318 }, | 387 } |
319 "limit": { | 388 }, |
320 "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.", | 389 "type": "object" |
321 "format": "int32", | 390 }, |
322 "type": "integer" | 391 "BeginTransactionRequest": { |
323 }, | 392 "description": "The request for Datastore.BeginTransaction.", |
324 "filter": { | 393 "id": "BeginTransactionRequest", |
325 "$ref": "Filter", | 394 "properties": {}, |
326 "description": "The filter to apply." | 395 "type": "object" |
327 }, | 396 }, |
328 "offset": { | 397 "PropertyOrder": { |
329 "description": "The number of results to skip. Applies befor
e limit, but after all other\nconstraints. Optional. Must be >= 0 if specified."
, | 398 "description": "The desired order for a specific property.", |
330 "format": "int32", | 399 "id": "PropertyOrder", |
331 "type": "integer" | 400 "properties": { |
332 }, | 401 "direction": { |
333 "startCursor": { | 402 "description": "The direction to order by. Defaults to `ASCE
NDING`.", |
334 "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).", | 403 "enum": [ |
335 "format": "byte", | 404 "DIRECTION_UNSPECIFIED", |
336 "type": "string" | 405 "ASCENDING", |
337 }, | 406 "DESCENDING" |
338 "kind": { | 407 ], |
339 "description": "The kinds to query (if empty, returns entiti
es of all kinds).\nCurrently at most 1 kind may be specified.", | 408 "enumDescriptions": [ |
340 "items": { | 409 "Unspecified. This value must not be used.", |
341 "$ref": "KindExpression" | 410 "Ascending.", |
342 }, | 411 "Descending." |
343 "type": "array" | 412 ], |
344 }, | 413 "type": "string" |
345 "distinctOn": { | |
346 "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).", | |
347 "items": { | |
348 "$ref": "PropertyReference" | |
349 }, | |
350 "type": "array" | |
351 }, | |
352 "order": { | |
353 "description": "The order to apply to the query results (if
empty, order is unspecified).", | |
354 "items": { | |
355 "$ref": "PropertyOrder" | |
356 }, | |
357 "type": "array" | |
358 } | |
359 }, | |
360 "type": "object" | |
361 }, | |
362 "PropertyFilter": { | |
363 "description": "A filter on a specific property.", | |
364 "id": "PropertyFilter", | |
365 "properties": { | |
366 "value": { | |
367 "$ref": "Value", | |
368 "description": "The value to compare the property to." | |
369 }, | 414 }, |
370 "property": { | 415 "property": { |
371 "$ref": "PropertyReference", | 416 "$ref": "PropertyReference", |
372 "description": "The property to filter by." | 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": { |
| 505 "description": "A mutation to apply to an entity.", |
| 506 "id": "Mutation", |
| 507 "properties": { |
| 508 "delete": { |
| 509 "$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." |
| 511 }, |
| 512 "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.", |
| 514 "format": "int64", |
| 515 "type": "string" |
| 516 }, |
| 517 "insert": { |
| 518 "$ref": "Entity", |
| 519 "description": "The entity to insert. The entity must not al
ready exist.\nThe entity key's final path element may be incomplete." |
| 520 }, |
| 521 "update": { |
| 522 "$ref": "Entity", |
| 523 "description": "The entity to update. The entity must alread
y exist.\nMust have a complete key path." |
| 524 }, |
| 525 "upsert": { |
| 526 "$ref": "Entity", |
| 527 "description": "The entity to upsert. The entity may or may
not already exist.\nThe entity key's final path element may be incomplete." |
| 528 } |
| 529 }, |
| 530 "type": "object" |
| 531 }, |
| 532 "ReadOptions": { |
| 533 "description": "The options shared by read requests.", |
| 534 "id": "ReadOptions", |
| 535 "properties": { |
| 536 "transaction": { |
| 537 "description": "The identifier of the transaction in which t
o read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTrans
action.", |
| 538 "format": "byte", |
| 539 "type": "string" |
| 540 }, |
| 541 "readConsistency": { |
| 542 "description": "The non-transactional read consistency to us
e.\nCannot be set to `STRONG` for global queries.", |
| 543 "enum": [ |
| 544 "READ_CONSISTENCY_UNSPECIFIED", |
| 545 "STRONG", |
| 546 "EVENTUAL" |
| 547 ], |
| 548 "enumDescriptions": [ |
| 549 "Unspecified. This value must not be used.", |
| 550 "Strong consistency.", |
| 551 "Eventual consistency." |
| 552 ], |
| 553 "type": "string" |
| 554 } |
| 555 }, |
| 556 "type": "object" |
| 557 }, |
| 558 "RollbackResponse": { |
| 559 "description": "The response for Datastore.Rollback.\n(an empty mess
age).", |
| 560 "id": "RollbackResponse", |
| 561 "properties": {}, |
| 562 "type": "object" |
| 563 }, |
| 564 "MutationResult": { |
| 565 "description": "The result of applying a mutation.", |
| 566 "id": "MutationResult", |
| 567 "properties": { |
| 568 "key": { |
| 569 "$ref": "Key", |
| 570 "description": "The automatically allocated key.\nSet only w
hen the mutation allocated a key." |
| 571 }, |
| 572 "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.", |
| 574 "format": "int64", |
| 575 "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 } |
| 581 }, |
| 582 "type": "object" |
| 583 }, |
| 584 "GqlQuery": { |
| 585 "description": "A [GQL query](https://cloud.google.com/datastore/doc
s/apis/gql/gql_reference).", |
| 586 "id": "GqlQuery", |
| 587 "properties": { |
| 588 "queryString": { |
| 589 "description": "A string of the format described\n[here](htt
ps://cloud.google.com/datastore/docs/apis/gql/gql_reference).", |
| 590 "type": "string" |
| 591 }, |
| 592 "positionalBindings": { |
| 593 "description": "Numbered binding site @1 references the firs
t numbered parameter,\neffectively using 1-based indexing, rather than the usual
0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th
\nnumbered parameter. The inverse must also be true.", |
| 594 "items": { |
| 595 "$ref": "GqlQueryParameter" |
| 596 }, |
| 597 "type": "array" |
| 598 }, |
| 599 "namedBindings": { |
| 600 "additionalProperties": { |
| 601 "$ref": "GqlQueryParameter" |
| 602 }, |
| 603 "description": "For each non-reserved named binding site in
the query string, there must be\na named parameter with that name, but not neces
sarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`
__.*__`, and must not be `\"\"`.", |
| 604 "type": "object" |
| 605 }, |
| 606 "allowLiterals": { |
| 607 "description": "When false, the query string must not contai
n any literals and instead must\nbind all values. For example,\n`SELECT * FROM K
ind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE
a = @value` is.", |
| 608 "type": "boolean" |
| 609 } |
| 610 }, |
| 611 "type": "object" |
| 612 }, |
| 613 "Filter": { |
| 614 "description": "A holder for any type of filter.", |
| 615 "id": "Filter", |
| 616 "properties": { |
| 617 "compositeFilter": { |
| 618 "$ref": "CompositeFilter", |
| 619 "description": "A composite filter." |
| 620 }, |
| 621 "propertyFilter": { |
| 622 "$ref": "PropertyFilter", |
| 623 "description": "A filter on a property." |
| 624 } |
| 625 }, |
| 626 "type": "object" |
| 627 }, |
| 628 "RollbackRequest": { |
| 629 "description": "The request for Datastore.Rollback.", |
| 630 "id": "RollbackRequest", |
| 631 "properties": { |
| 632 "transaction": { |
| 633 "description": "The transaction identifier, returned by a ca
ll to\nDatastore.BeginTransaction.", |
| 634 "format": "byte", |
| 635 "type": "string" |
| 636 } |
| 637 }, |
| 638 "type": "object" |
| 639 }, |
| 640 "RunQueryRequest": { |
| 641 "description": "The request for Datastore.RunQuery.", |
| 642 "id": "RunQueryRequest", |
| 643 "properties": { |
| 644 "gqlQuery": { |
| 645 "$ref": "GqlQuery", |
| 646 "description": "The GQL query to run." |
| 647 }, |
| 648 "partitionId": { |
| 649 "$ref": "PartitionId", |
| 650 "description": "Entities are partitioned into subsets, ident
ified by a partition ID.\nQueries are scoped to a single partition.\nThis partit
ion ID is normalized with the standard default context\npartition ID." |
| 651 }, |
| 652 "readOptions": { |
| 653 "$ref": "ReadOptions", |
| 654 "description": "The options for this query." |
| 655 }, |
| 656 "query": { |
| 657 "$ref": "Query", |
| 658 "description": "The query to run." |
| 659 } |
| 660 }, |
| 661 "type": "object" |
| 662 }, |
| 663 "CompositeFilter": { |
| 664 "description": "A filter that merges multiple other filters using th
e given operator.", |
| 665 "id": "CompositeFilter", |
| 666 "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" |
373 }, | 673 }, |
374 "op": { | 674 "op": { |
375 "description": "The operator to filter by.", | 675 "description": "The operator for combining multiple filters.
", |
376 "enum": [ | 676 "enum": [ |
377 "OPERATOR_UNSPECIFIED", | 677 "OPERATOR_UNSPECIFIED", |
378 "LESS_THAN", | 678 "AND" |
379 "LESS_THAN_OR_EQUAL", | |
380 "GREATER_THAN", | |
381 "GREATER_THAN_OR_EQUAL", | |
382 "EQUAL", | |
383 "HAS_ANCESTOR" | |
384 ], | 679 ], |
385 "enumDescriptions": [ | 680 "enumDescriptions": [ |
386 "Unspecified. This value must not be used.", | 681 "Unspecified. This value must not be used.", |
387 "Less than.", | 682 "The results are required to satisfy each of the combine
d filters." |
388 "Less than or equal.", | 683 ], |
389 "Greater than.", | 684 "type": "string" |
390 "Greater than or equal.", | 685 } |
391 "Equal.", | 686 }, |
392 "Has ancestor." | 687 "type": "object" |
393 ], | 688 }, |
394 "type": "string" | 689 "AllocateIdsResponse": { |
395 } | 690 "description": "The response for Datastore.AllocateIds.", |
396 }, | 691 "id": "AllocateIdsResponse", |
397 "type": "object" | |
398 }, | |
399 "EntityResult": { | |
400 "description": "The result of fetching an entity from Datastore.", | |
401 "id": "EntityResult", | |
402 "properties": { | |
403 "cursor": { | |
404 "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.", | |
405 "format": "byte", | |
406 "type": "string" | |
407 }, | |
408 "version": { | |
409 "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.", | |
410 "format": "int64", | |
411 "type": "string" | |
412 }, | |
413 "entity": { | |
414 "$ref": "Entity", | |
415 "description": "The resulting entity." | |
416 } | |
417 }, | |
418 "type": "object" | |
419 }, | |
420 "CommitResponse": { | |
421 "description": "The response for Datastore.Commit.", | |
422 "id": "CommitResponse", | |
423 "properties": { | |
424 "mutationResults": { | |
425 "description": "The result of performing the mutations.\nThe
i-th mutation result corresponds to the i-th mutation in the request.", | |
426 "items": { | |
427 "$ref": "MutationResult" | |
428 }, | |
429 "type": "array" | |
430 }, | |
431 "indexUpdates": { | |
432 "description": "The number of index entries updated during t
he commit, or zero if none were\nupdated.", | |
433 "format": "int32", | |
434 "type": "integer" | |
435 } | |
436 }, | |
437 "type": "object" | |
438 }, | |
439 "Value": { | |
440 "description": "A message that can hold any of the supported value t
ypes and associated\nmetadata.", | |
441 "id": "Value", | |
442 "properties": { | |
443 "timestampValue": { | |
444 "description": "A timestamp value.\nWhen stored in the Datas
tore, precise only to microseconds;\nany additional precision is rounded down.", | |
445 "format": "google-datetime", | |
446 "type": "string" | |
447 }, | |
448 "booleanValue": { | |
449 "description": "A boolean value.", | |
450 "type": "boolean" | |
451 }, | |
452 "nullValue": { | |
453 "description": "A null value.", | |
454 "enum": [ | |
455 "NULL_VALUE" | |
456 ], | |
457 "enumDescriptions": [ | |
458 "Null value." | |
459 ], | |
460 "type": "string" | |
461 }, | |
462 "blobValue": { | |
463 "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.", | |
464 "format": "byte", | |
465 "type": "string" | |
466 }, | |
467 "meaning": { | |
468 "description": "The `meaning` field should only be populated
for backwards compatibility.", | |
469 "format": "int32", | |
470 "type": "integer" | |
471 }, | |
472 "arrayValue": { | |
473 "$ref": "ArrayValue", | |
474 "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`." | |
475 }, | |
476 "entityValue": { | |
477 "$ref": "Entity", | |
478 "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." | |
479 }, | |
480 "geoPointValue": { | |
481 "$ref": "LatLng", | |
482 "description": "A geo point value representing a point on th
e surface of Earth." | |
483 }, | |
484 "integerValue": { | |
485 "description": "An integer value.", | |
486 "format": "int64", | |
487 "type": "string" | |
488 }, | |
489 "keyValue": { | |
490 "$ref": "Key", | |
491 "description": "A key value." | |
492 }, | |
493 "stringValue": { | |
494 "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.", | |
495 "type": "string" | |
496 }, | |
497 "excludeFromIndexes": { | |
498 "description": "If the value should be excluded from all ind
exes including those defined\nexplicitly.", | |
499 "type": "boolean" | |
500 }, | |
501 "doubleValue": { | |
502 "description": "A double value.", | |
503 "format": "double", | |
504 "type": "number" | |
505 } | |
506 }, | |
507 "type": "object" | |
508 }, | |
509 "PartitionId": { | |
510 "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.", | |
511 "id": "PartitionId", | |
512 "properties": { | |
513 "projectId": { | |
514 "description": "The ID of the project to which the entities
belong.", | |
515 "type": "string" | |
516 }, | |
517 "namespaceId": { | |
518 "description": "If not empty, the ID of the namespace to whi
ch the entities belong.", | |
519 "type": "string" | |
520 } | |
521 }, | |
522 "type": "object" | |
523 }, | |
524 "Entity": { | |
525 "description": "A Datastore data object.\n\nAn entity is limited to
1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for
the serialized form of this\nmessage.", | |
526 "id": "Entity", | |
527 "properties": { | |
528 "key": { | |
529 "$ref": "Key", | |
530 "description": "The entity's key.\n\nAn entity must have a k
ey, unless otherwise documented (for example,\nan entity in `Value.entity_value`
may have no key).\nAn entity's kind is its key path's last element's kind,\nor
null if it has no key." | |
531 }, | |
532 "properties": { | |
533 "additionalProperties": { | |
534 "$ref": "Value" | |
535 }, | |
536 "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 `\"\"`.", | |
537 "type": "object" | |
538 } | |
539 }, | |
540 "type": "object" | |
541 }, | |
542 "LookupRequest": { | |
543 "description": "The request for Datastore.Lookup.", | |
544 "id": "LookupRequest", | |
545 "properties": { | 692 "properties": { |
546 "keys": { | 693 "keys": { |
547 "description": "Keys of entities to look up.", | 694 "description": "The keys specified in the request (in the sa
me order), each with\nits key path completed with a newly allocated ID.", |
548 "items": { | 695 "items": { |
549 "$ref": "Key" | 696 "$ref": "Key" |
550 }, | 697 }, |
551 "type": "array" | |
552 }, | |
553 "readOptions": { | |
554 "$ref": "ReadOptions", | |
555 "description": "The options for this lookup request." | |
556 } | |
557 }, | |
558 "type": "object" | |
559 }, | |
560 "QueryResultBatch": { | |
561 "description": "A batch of results produced by a query.", | |
562 "id": "QueryResultBatch", | |
563 "properties": { | |
564 "skippedCursor": { | |
565 "description": "A cursor that points to the position after t
he last skipped result.\nWill be set when `skipped_results` != 0.", | |
566 "format": "byte", | |
567 "type": "string" | |
568 }, | |
569 "skippedResults": { | |
570 "description": "The number of results skipped, typically bec
ause of an offset.", | |
571 "format": "int32", | |
572 "type": "integer" | |
573 }, | |
574 "entityResultType": { | |
575 "description": "The result type for every entity in `entity_
results`.", | |
576 "enum": [ | |
577 "RESULT_TYPE_UNSPECIFIED", | |
578 "FULL", | |
579 "PROJECTION", | |
580 "KEY_ONLY" | |
581 ], | |
582 "enumDescriptions": [ | |
583 "Unspecified. This value is never used.", | |
584 "The key and properties.", | |
585 "A projected subset of properties. The entity may have n
o key.", | |
586 "Only the key." | |
587 ], | |
588 "type": "string" | |
589 }, | |
590 "entityResults": { | |
591 "description": "The results for this batch.", | |
592 "items": { | |
593 "$ref": "EntityResult" | |
594 }, | |
595 "type": "array" | |
596 }, | |
597 "moreResults": { | |
598 "description": "The state of the query after the current bat
ch.", | |
599 "enum": [ | |
600 "MORE_RESULTS_TYPE_UNSPECIFIED", | |
601 "NOT_FINISHED", | |
602 "MORE_RESULTS_AFTER_LIMIT", | |
603 "MORE_RESULTS_AFTER_CURSOR", | |
604 "NO_MORE_RESULTS" | |
605 ], | |
606 "enumDescriptions": [ | |
607 "Unspecified. This value is never used.", | |
608 "There may be additional batches to fetch from this quer
y.", | |
609 "The query is finished, but there may be more results af
ter the limit.", | |
610 "The query is finished, but there may be more results af
ter the end\ncursor.", | |
611 "The query has been exhausted." | |
612 ], | |
613 "type": "string" | |
614 }, | |
615 "endCursor": { | |
616 "description": "A cursor that points to the position after t
he last result in the batch.", | |
617 "format": "byte", | |
618 "type": "string" | |
619 }, | |
620 "snapshotVersion": { | |
621 "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.", | |
622 "format": "int64", | |
623 "type": "string" | |
624 } | |
625 }, | |
626 "type": "object" | |
627 }, | |
628 "PathElement": { | |
629 "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.", | |
630 "id": "PathElement", | |
631 "properties": { | |
632 "kind": { | |
633 "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 `\"\"`.", | |
634 "type": "string" | |
635 }, | |
636 "id": { | |
637 "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.", | |
638 "format": "int64", | |
639 "type": "string" | |
640 }, | |
641 "name": { | |
642 "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 `\"\"`.", | |
643 "type": "string" | |
644 } | |
645 }, | |
646 "type": "object" | |
647 }, | |
648 "GqlQueryParameter": { | |
649 "description": "A binding parameter for a GQL query.", | |
650 "id": "GqlQueryParameter", | |
651 "properties": { | |
652 "cursor": { | |
653 "description": "A query cursor. Query cursors are returned i
n query\nresult batches.", | |
654 "format": "byte", | |
655 "type": "string" | |
656 }, | |
657 "value": { | |
658 "$ref": "Value", | |
659 "description": "A value parameter." | |
660 } | |
661 }, | |
662 "type": "object" | |
663 }, | |
664 "BeginTransactionResponse": { | |
665 "description": "The response for Datastore.BeginTransaction.", | |
666 "id": "BeginTransactionResponse", | |
667 "properties": { | |
668 "transaction": { | |
669 "description": "The transaction identifier (always present).
", | |
670 "format": "byte", | |
671 "type": "string" | |
672 } | |
673 }, | |
674 "type": "object" | |
675 }, | |
676 "AllocateIdsRequest": { | |
677 "description": "The request for Datastore.AllocateIds.", | |
678 "id": "AllocateIdsRequest", | |
679 "properties": { | |
680 "keys": { | |
681 "description": "A list of keys with incomplete key paths for
which to allocate IDs.\nNo key may be reserved/read-only.", | |
682 "items": { | |
683 "$ref": "Key" | |
684 }, | |
685 "type": "array" | 698 "type": "array" |
686 } | 699 } |
687 }, | 700 }, |
688 "type": "object" | 701 "type": "object" |
689 }, | 702 }, |
690 "LookupResponse": { | 703 "Query": { |
691 "description": "The response for Datastore.Lookup.", | 704 "description": "A query for entities.", |
692 "id": "LookupResponse", | 705 "id": "Query", |
693 "properties": { | 706 "properties": { |
694 "deferred": { | 707 "kind": { |
695 "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.", | 708 "description": "The kinds to query (if empty, returns entiti
es of all kinds).\nCurrently at most 1 kind may be specified.", |
696 "items": { | 709 "items": { |
697 "$ref": "Key" | 710 "$ref": "KindExpression" |
698 }, | 711 }, |
699 "type": "array" | 712 "type": "array" |
700 }, | 713 }, |
701 "missing": { | 714 "distinctOn": { |
702 "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.", | 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).", |
703 "items": { | 716 "items": { |
704 "$ref": "EntityResult" | 717 "$ref": "PropertyReference" |
705 }, | 718 }, |
706 "type": "array" | 719 "type": "array" |
707 }, | 720 }, |
708 "found": { | 721 "order": { |
709 "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.", | 722 "description": "The order to apply to the query results (if
empty, order is unspecified).", |
710 "items": { | 723 "items": { |
711 "$ref": "EntityResult" | 724 "$ref": "PropertyOrder" |
712 }, | 725 }, |
713 "type": "array" | 726 "type": "array" |
714 } | 727 }, |
715 }, | 728 "projection": { |
716 "type": "object" | 729 "description": "The projection to return. Defaults to return
ing all properties.", |
717 }, | 730 "items": { |
718 "RunQueryResponse": { | 731 "$ref": "Projection" |
719 "description": "The response for Datastore.RunQuery.", | 732 }, |
720 "id": "RunQueryResponse", | 733 "type": "array" |
721 "properties": { | 734 }, |
722 "batch": { | 735 "endCursor": { |
723 "$ref": "QueryResultBatch", | 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).", |
724 "description": "A batch of query results (always present)." | 737 "format": "byte", |
725 }, | 738 "type": "string" |
726 "query": { | 739 }, |
727 "$ref": "Query", | 740 "limit": { |
728 "description": "The parsed form of the `GqlQuery` from the r
equest, if it was set." | 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.", |
729 } | 742 "format": "int32", |
730 }, | 743 "type": "integer" |
731 "type": "object" | 744 }, |
732 }, | 745 "filter": { |
733 "PropertyOrder": { | 746 "$ref": "Filter", |
734 "description": "The desired order for a specific property.", | 747 "description": "The filter to apply." |
735 "id": "PropertyOrder", | 748 }, |
736 "properties": { | 749 "offset": { |
737 "direction": { | 750 "description": "The number of results to skip. Applies befor
e limit, but after all other\nconstraints. Optional. Must be >= 0 if specified."
, |
738 "description": "The direction to order by. Defaults to `ASCE
NDING`.", | 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 } |
| 759 }, |
| 760 "type": "object" |
| 761 }, |
| 762 "PropertyFilter": { |
| 763 "description": "A filter on a specific property.", |
| 764 "id": "PropertyFilter", |
| 765 "properties": { |
| 766 "value": { |
| 767 "$ref": "Value", |
| 768 "description": "The value to compare the property to." |
| 769 }, |
| 770 "property": { |
| 771 "$ref": "PropertyReference", |
| 772 "description": "The property to filter by." |
| 773 }, |
| 774 "op": { |
| 775 "description": "The operator to filter by.", |
739 "enum": [ | 776 "enum": [ |
740 "DIRECTION_UNSPECIFIED", | 777 "OPERATOR_UNSPECIFIED", |
741 "ASCENDING", | 778 "LESS_THAN", |
742 "DESCENDING" | 779 "LESS_THAN_OR_EQUAL", |
| 780 "GREATER_THAN", |
| 781 "GREATER_THAN_OR_EQUAL", |
| 782 "EQUAL", |
| 783 "HAS_ANCESTOR" |
743 ], | 784 ], |
744 "enumDescriptions": [ | 785 "enumDescriptions": [ |
745 "Unspecified. This value must not be used.", | 786 "Unspecified. This value must not be used.", |
746 "Ascending.", | 787 "Less than.", |
747 "Descending." | 788 "Less than or equal.", |
748 ], | 789 "Greater than.", |
749 "type": "string" | 790 "Greater than or equal.", |
750 }, | 791 "Equal.", |
751 "property": { | 792 "Has ancestor." |
752 "$ref": "PropertyReference", | 793 ], |
753 "description": "The property to order by." | 794 "type": "string" |
754 } | 795 } |
755 }, | 796 }, |
756 "type": "object" | 797 "type": "object" |
757 }, | 798 }, |
758 "BeginTransactionRequest": { | 799 "EntityResult": { |
759 "description": "The request for Datastore.BeginTransaction.", | 800 "description": "The result of fetching an entity from Datastore.", |
760 "id": "BeginTransactionRequest", | 801 "id": "EntityResult", |
761 "properties": {}, | 802 "properties": { |
762 "type": "object" | 803 "cursor": { |
763 }, | 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.", |
764 "CommitRequest": { | 805 "format": "byte", |
765 "description": "The request for Datastore.Commit.", | 806 "type": "string" |
766 "id": "CommitRequest", | 807 }, |
767 "properties": { | 808 "version": { |
768 "transaction": { | 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.", |
769 "description": "The identifier of the transaction associated
with the commit. A\ntransaction identifier is returned by a call to\nDatastore.
BeginTransaction.", | 810 "format": "int64", |
770 "format": "byte", | 811 "type": "string" |
771 "type": "string" | 812 }, |
772 }, | 813 "entity": { |
773 "mode": { | 814 "$ref": "Entity", |
774 "description": "The type of commit to perform. Defaults to `
TRANSACTIONAL`.", | 815 "description": "The resulting entity." |
| 816 } |
| 817 }, |
| 818 "type": "object" |
| 819 }, |
| 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": { |
| 840 "description": "A message that can hold any of the supported value t
ypes and associated\nmetadata.", |
| 841 "id": "Value", |
| 842 "properties": { |
| 843 "booleanValue": { |
| 844 "description": "A boolean value.", |
| 845 "type": "boolean" |
| 846 }, |
| 847 "nullValue": { |
| 848 "description": "A null value.", |
775 "enum": [ | 849 "enum": [ |
776 "MODE_UNSPECIFIED", | 850 "NULL_VALUE" |
777 "TRANSACTIONAL", | |
778 "NON_TRANSACTIONAL" | |
779 ], | 851 ], |
780 "enumDescriptions": [ | 852 "enumDescriptions": [ |
781 "Unspecified. This value must not be used.", | 853 "Null value." |
782 "Transactional: The mutations are either all applied, or
none are applied.\nLearn about transactions [here](https://cloud.google.com/dat
astore/docs/concepts/transactions).", | 854 ], |
783 "Non-transactional: The mutations may not apply as all o
r none." | 855 "type": "string" |
784 ], | 856 }, |
785 "type": "string" | 857 "blobValue": { |
786 }, | 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.", |
787 "mutations": { | 859 "format": "byte", |
788 "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.", | 860 "type": "string" |
789 "items": { | 861 }, |
790 "$ref": "Mutation" | 862 "meaning": { |
791 }, | 863 "description": "The `meaning` field should only be populated
for backwards compatibility.", |
792 "type": "array" | 864 "format": "int32", |
793 } | 865 "type": "integer" |
794 }, | 866 }, |
795 "type": "object" | 867 "arrayValue": { |
796 }, | 868 "$ref": "ArrayValue", |
797 "KindExpression": { | 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`." |
798 "description": "A representation of a kind.", | 870 }, |
799 "id": "KindExpression", | 871 "entityValue": { |
800 "properties": { | 872 "$ref": "Entity", |
801 "name": { | 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." |
802 "description": "The name of the kind.", | 874 }, |
803 "type": "string" | 875 "geoPointValue": { |
804 } | 876 "$ref": "LatLng", |
805 }, | 877 "description": "A geo point value representing a point on th
e surface of Earth." |
806 "type": "object" | 878 }, |
807 }, | 879 "integerValue": { |
808 "LatLng": { | 880 "description": "An integer value.", |
809 "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)", | 881 "format": "int64", |
810 "id": "LatLng", | 882 "type": "string" |
811 "properties": { | 883 }, |
812 "latitude": { | 884 "keyValue": { |
813 "description": "The latitude in degrees. It must be in the r
ange [-90.0, +90.0].", | 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.", |
814 "format": "double", | 898 "format": "double", |
815 "type": "number" | 899 "type": "number" |
816 }, | 900 }, |
817 "longitude": { | 901 "timestampValue": { |
818 "description": "The longitude in degrees. It must be in the
range [-180.0, +180.0].", | 902 "description": "A timestamp value.\nWhen stored in the Datas
tore, precise only to microseconds;\nany additional precision is rounded down.", |
819 "format": "double", | 903 "format": "google-datetime", |
820 "type": "number" | 904 "type": "string" |
821 } | 905 } |
822 }, | 906 }, |
823 "type": "object" | 907 "type": "object" |
824 }, | 908 }, |
825 "Key": { | 909 "PartitionId": { |
826 "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.", | 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.", |
827 "id": "Key", | 911 "id": "PartitionId", |
828 "properties": { | 912 "properties": { |
829 "partitionId": { | 913 "namespaceId": { |
830 "$ref": "PartitionId", | 914 "description": "If not empty, the ID of the namespace to whi
ch the entities belong.", |
831 "description": "Entities are partitioned into subsets, curre
ntly identified by a project\nID and namespace ID.\nQueries are scoped to a sing
le partition." | 915 "type": "string" |
832 }, | 916 }, |
833 "path": { | 917 "projectId": { |
834 "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.", | 918 "description": "The ID of the project to which the entities
belong.", |
835 "items": { | 919 "type": "string" |
836 "$ref": "PathElement" | 920 } |
837 }, | 921 }, |
838 "type": "array" | 922 "type": "object" |
839 } | 923 }, |
840 }, | 924 "Entity": { |
841 "type": "object" | 925 "description": "A Datastore data object.\n\nAn entity is limited to
1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for
the serialized form of this\nmessage.", |
842 }, | 926 "id": "Entity", |
843 "PropertyReference": { | 927 "properties": { |
844 "description": "A reference to a property relative to the kind expre
ssions.", | |
845 "id": "PropertyReference", | |
846 "properties": { | |
847 "name": { | |
848 "description": "The name of the property.\nIf name includes
\".\"s, it may be interpreted as a property name path.", | |
849 "type": "string" | |
850 } | |
851 }, | |
852 "type": "object" | |
853 }, | |
854 "Projection": { | |
855 "description": "A representation of a property in a projection.", | |
856 "id": "Projection", | |
857 "properties": { | |
858 "property": { | |
859 "$ref": "PropertyReference", | |
860 "description": "The property to project." | |
861 } | |
862 }, | |
863 "type": "object" | |
864 }, | |
865 "ArrayValue": { | |
866 "description": "An array value.", | |
867 "id": "ArrayValue", | |
868 "properties": { | |
869 "values": { | |
870 "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.", | |
871 "items": { | |
872 "$ref": "Value" | |
873 }, | |
874 "type": "array" | |
875 } | |
876 }, | |
877 "type": "object" | |
878 }, | |
879 "Mutation": { | |
880 "description": "A mutation to apply to an entity.", | |
881 "id": "Mutation", | |
882 "properties": { | |
883 "baseVersion": { | |
884 "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.", | |
885 "format": "int64", | |
886 "type": "string" | |
887 }, | |
888 "insert": { | |
889 "$ref": "Entity", | |
890 "description": "The entity to insert. The entity must not al
ready exist.\nThe entity key's final path element may be incomplete." | |
891 }, | |
892 "update": { | |
893 "$ref": "Entity", | |
894 "description": "The entity to update. The entity must alread
y exist.\nMust have a complete key path." | |
895 }, | |
896 "upsert": { | |
897 "$ref": "Entity", | |
898 "description": "The entity to upsert. The entity may or may
not already exist.\nThe entity key's final path element may be incomplete." | |
899 }, | |
900 "delete": { | |
901 "$ref": "Key", | |
902 "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." | |
903 } | |
904 }, | |
905 "type": "object" | |
906 }, | |
907 "ReadOptions": { | |
908 "description": "The options shared by read requests.", | |
909 "id": "ReadOptions", | |
910 "properties": { | |
911 "transaction": { | |
912 "description": "The identifier of the transaction in which t
o read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTrans
action.", | |
913 "format": "byte", | |
914 "type": "string" | |
915 }, | |
916 "readConsistency": { | |
917 "description": "The non-transactional read consistency to us
e.\nCannot be set to `STRONG` for global queries.", | |
918 "enum": [ | |
919 "READ_CONSISTENCY_UNSPECIFIED", | |
920 "STRONG", | |
921 "EVENTUAL" | |
922 ], | |
923 "enumDescriptions": [ | |
924 "Unspecified. This value must not be used.", | |
925 "Strong consistency.", | |
926 "Eventual consistency." | |
927 ], | |
928 "type": "string" | |
929 } | |
930 }, | |
931 "type": "object" | |
932 }, | |
933 "RollbackResponse": { | |
934 "description": "The response for Datastore.Rollback.\n(an empty mess
age).", | |
935 "id": "RollbackResponse", | |
936 "properties": {}, | |
937 "type": "object" | |
938 }, | |
939 "MutationResult": { | |
940 "description": "The result of applying a mutation.", | |
941 "id": "MutationResult", | |
942 "properties": { | |
943 "conflictDetected": { | |
944 "description": "Whether a conflict was detected for this mut
ation. Always false when a\nconflict detection strategy field is not set in the
mutation.", | |
945 "type": "boolean" | |
946 }, | |
947 "key": { | 928 "key": { |
948 "$ref": "Key", | 929 "$ref": "Key", |
949 "description": "The automatically allocated key.\nSet only w
hen the mutation allocated a key." | 930 "description": "The entity's key.\n\nAn entity must have a k
ey, unless otherwise documented (for example,\nan entity in `Value.entity_value`
may have no key).\nAn entity's kind is its key path's last element's kind,\nor
null if it has no key." |
950 }, | 931 }, |
951 "version": { | 932 "properties": { |
952 "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.", | 933 "additionalProperties": { |
| 934 "$ref": "Value" |
| 935 }, |
| 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 `\"\"`.", |
| 937 "type": "object" |
| 938 } |
| 939 }, |
| 940 "type": "object" |
| 941 }, |
| 942 "QueryResultBatch": { |
| 943 "description": "A batch of results produced by a query.", |
| 944 "id": "QueryResultBatch", |
| 945 "properties": { |
| 946 "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.", |
953 "format": "int64", | 948 "format": "int64", |
954 "type": "string" | 949 "type": "string" |
955 } | 950 }, |
956 }, | 951 "skippedCursor": { |
957 "type": "object" | 952 "description": "A cursor that points to the position after t
he last skipped result.\nWill be set when `skipped_results` != 0.", |
958 }, | 953 "format": "byte", |
959 "GqlQuery": { | 954 "type": "string" |
960 "description": "A [GQL query](https://cloud.google.com/datastore/doc
s/apis/gql/gql_reference).", | 955 }, |
961 "id": "GqlQuery", | 956 "skippedResults": { |
962 "properties": { | 957 "description": "The number of results skipped, typically bec
ause of an offset.", |
963 "queryString": { | 958 "format": "int32", |
964 "description": "A string of the format described\n[here](htt
ps://cloud.google.com/datastore/docs/apis/gql/gql_reference).", | 959 "type": "integer" |
965 "type": "string" | 960 }, |
966 }, | 961 "entityResultType": { |
967 "positionalBindings": { | 962 "description": "The result type for every entity in `entity_
results`.", |
968 "description": "Numbered binding site @1 references the firs
t numbered parameter,\neffectively using 1-based indexing, rather than the usual
0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th
\nnumbered parameter. The inverse must also be true.", | 963 "enum": [ |
969 "items": { | 964 "RESULT_TYPE_UNSPECIFIED", |
970 "$ref": "GqlQueryParameter" | 965 "FULL", |
971 }, | 966 "PROJECTION", |
972 "type": "array" | 967 "KEY_ONLY" |
973 }, | 968 ], |
974 "namedBindings": { | 969 "enumDescriptions": [ |
975 "additionalProperties": { | 970 "Unspecified. This value is never used.", |
976 "$ref": "GqlQueryParameter" | 971 "The key and properties.", |
977 }, | 972 "A projected subset of properties. The entity may have n
o key.", |
978 "description": "For each non-reserved named binding site in
the query string, there must be\na named parameter with that name, but not neces
sarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`
__.*__`, and must not be `\"\"`.", | 973 "Only the key." |
979 "type": "object" | 974 ], |
980 }, | 975 "type": "string" |
981 "allowLiterals": { | 976 }, |
982 "description": "When false, the query string must not contai
n any literals and instead must\nbind all values. For example,\n`SELECT * FROM K
ind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE
a = @value` is.", | 977 "entityResults": { |
983 "type": "boolean" | 978 "description": "The results for this batch.", |
984 } | 979 "items": { |
985 }, | 980 "$ref": "EntityResult" |
986 "type": "object" | 981 }, |
987 }, | 982 "type": "array" |
988 "Filter": { | 983 }, |
989 "description": "A holder for any type of filter.", | 984 "endCursor": { |
990 "id": "Filter", | 985 "description": "A cursor that points to the position after t
he last result in the batch.", |
991 "properties": { | 986 "format": "byte", |
992 "compositeFilter": { | 987 "type": "string" |
993 "$ref": "CompositeFilter", | 988 }, |
994 "description": "A composite filter." | 989 "moreResults": { |
995 }, | 990 "description": "The state of the query after the current bat
ch.", |
996 "propertyFilter": { | 991 "enum": [ |
997 "$ref": "PropertyFilter", | 992 "MORE_RESULTS_TYPE_UNSPECIFIED", |
998 "description": "A filter on a property." | 993 "NOT_FINISHED", |
999 } | 994 "MORE_RESULTS_AFTER_LIMIT", |
1000 }, | 995 "MORE_RESULTS_AFTER_CURSOR", |
1001 "type": "object" | 996 "NO_MORE_RESULTS" |
1002 }, | 997 ], |
1003 "RollbackRequest": { | 998 "enumDescriptions": [ |
1004 "description": "The request for Datastore.Rollback.", | 999 "Unspecified. This value is never used.", |
1005 "id": "RollbackRequest", | 1000 "There may be additional batches to fetch from this quer
y.", |
1006 "properties": { | 1001 "The query is finished, but there may be more results af
ter the limit.", |
1007 "transaction": { | 1002 "The query is finished, but there may be more results af
ter the end\ncursor.", |
1008 "description": "The transaction identifier, returned by a ca
ll to\nDatastore.BeginTransaction.", | 1003 "The query is finished, and there are no more results." |
1009 "format": "byte", | 1004 ], |
1010 "type": "string" | 1005 "type": "string" |
1011 } | 1006 } |
1012 }, | 1007 }, |
1013 "type": "object" | 1008 "type": "object" |
1014 }, | 1009 }, |
1015 "RunQueryRequest": { | 1010 "LookupRequest": { |
1016 "description": "The request for Datastore.RunQuery.", | 1011 "description": "The request for Datastore.Lookup.", |
1017 "id": "RunQueryRequest", | 1012 "id": "LookupRequest", |
1018 "properties": { | 1013 "properties": { |
| 1014 "keys": { |
| 1015 "description": "Keys of entities to look up.", |
| 1016 "items": { |
| 1017 "$ref": "Key" |
| 1018 }, |
| 1019 "type": "array" |
| 1020 }, |
1019 "readOptions": { | 1021 "readOptions": { |
1020 "$ref": "ReadOptions", | 1022 "$ref": "ReadOptions", |
1021 "description": "The options for this query." | 1023 "description": "The options for this lookup request." |
1022 }, | 1024 } |
1023 "query": { | 1025 }, |
1024 "$ref": "Query", | 1026 "type": "object" |
1025 "description": "The query to run." | 1027 }, |
1026 }, | 1028 "PathElement": { |
1027 "gqlQuery": { | 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.", |
1028 "$ref": "GqlQuery", | 1030 "id": "PathElement", |
1029 "description": "The GQL query to run." | 1031 "properties": { |
1030 }, | 1032 "id": { |
1031 "partitionId": { | 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.", |
1032 "$ref": "PartitionId", | 1034 "format": "int64", |
1033 "description": "Entities are partitioned into subsets, ident
ified by a partition ID.\nQueries are scoped to a single partition.\nThis partit
ion ID is normalized with the standard default context\npartition ID." | 1035 "type": "string" |
1034 } | 1036 }, |
1035 }, | 1037 "name": { |
1036 "type": "object" | 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 `\"\"`.", |
1037 }, | 1039 "type": "string" |
1038 "CompositeFilter": { | 1040 }, |
1039 "description": "A filter that merges multiple other filters using th
e given operator.", | 1041 "kind": { |
1040 "id": "CompositeFilter", | 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 `\"\"`.", |
1041 "properties": { | 1043 "type": "string" |
1042 "filters": { | 1044 } |
1043 "description": "The list of filters to combine.\nMust contai
n at least one filter.", | 1045 }, |
1044 "items": { | 1046 "type": "object" |
1045 "$ref": "Filter" | 1047 }, |
1046 }, | 1048 "GqlQueryParameter": { |
1047 "type": "array" | 1049 "description": "A binding parameter for a GQL query.", |
1048 }, | 1050 "id": "GqlQueryParameter", |
1049 "op": { | 1051 "properties": { |
1050 "description": "The operator for combining multiple filters.
", | 1052 "value": { |
1051 "enum": [ | 1053 "$ref": "Value", |
1052 "OPERATOR_UNSPECIFIED", | 1054 "description": "A value parameter." |
1053 "AND" | 1055 }, |
1054 ], | 1056 "cursor": { |
1055 "enumDescriptions": [ | 1057 "description": "A query cursor. Query cursors are returned i
n query\nresult batches.", |
1056 "Unspecified. This value must not be used.", | 1058 "format": "byte", |
1057 "The results are required to satisfy each of the combine
d filters." | 1059 "type": "string" |
1058 ], | 1060 } |
1059 "type": "string" | 1061 }, |
1060 } | |
1061 }, | |
1062 "type": "object" | 1062 "type": "object" |
1063 } | 1063 } |
1064 }, | 1064 }, |
1065 "servicePath": "", | 1065 "servicePath": "", |
1066 "title": "Google Cloud Datastore API", | 1066 "title": "Google Cloud Datastore API", |
1067 "version": "v1" | 1067 "version": "v1" |
1068 } | 1068 } |
OLD | NEW |