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