OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/datastore": { |
| 6 "description": "View and manage your Google Cloud Datastore
data" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/userinfo.email": { |
| 9 "description": "View your email address" |
| 10 } |
| 11 } |
| 12 } |
| 13 }, |
| 14 "basePath": "/datastore/v1beta2/datasets/", |
| 15 "baseUrl": "https://www.googleapis.com/datastore/v1beta2/datasets/", |
| 16 "batchPath": "batch", |
| 17 "description": "API for accessing Google Cloud Datastore.", |
| 18 "discoveryVersion": "v1", |
| 19 "documentationLink": "https://developers.google.com/datastore/", |
| 20 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/2BYNDaZqMjLdfTtg3EL0oL8j6oI\"", |
| 21 "icons": { |
| 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 24 }, |
| 25 "id": "datastore:v1beta2", |
| 26 "kind": "discovery#restDescription", |
| 27 "name": "datastore", |
| 28 "ownerDomain": "google.com", |
| 29 "ownerName": "Google", |
| 30 "parameters": { |
| 31 "alt": { |
| 32 "default": "proto", |
| 33 "description": "Data format for the response.", |
| 34 "enum": [ |
| 35 "json", |
| 36 "proto" |
| 37 ], |
| 38 "enumDescriptions": [ |
| 39 "Responses with Content-Type of application/json", |
| 40 "Responses with Content-Type of application/x-protobuf" |
| 41 ], |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "fields": { |
| 46 "description": "Selector specifying which fields to include in a par
tial response.", |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "key": { |
| 51 "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.", |
| 52 "location": "query", |
| 53 "type": "string" |
| 54 }, |
| 55 "oauth_token": { |
| 56 "description": "OAuth 2.0 token for the current user.", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
| 60 "prettyPrint": { |
| 61 "default": "true", |
| 62 "description": "Returns response with indentations and line breaks."
, |
| 63 "location": "query", |
| 64 "type": "boolean" |
| 65 }, |
| 66 "quotaUser": { |
| 67 "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. Overrides userIp if both are provided.", |
| 68 "location": "query", |
| 69 "type": "string" |
| 70 }, |
| 71 "userIp": { |
| 72 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 73 "location": "query", |
| 74 "type": "string" |
| 75 } |
| 76 }, |
| 77 "protocol": "rest", |
| 78 "resources": { |
| 79 "datasets": { |
| 80 "methods": { |
| 81 "allocateIds": { |
| 82 "description": "Allocate IDs for incomplete keys (useful for
referencing an entity before it is inserted).", |
| 83 "httpMethod": "POST", |
| 84 "id": "datastore.datasets.allocateIds", |
| 85 "parameterOrder": [ |
| 86 "datasetId" |
| 87 ], |
| 88 "parameters": { |
| 89 "datasetId": { |
| 90 "description": "Identifies the dataset.", |
| 91 "location": "path", |
| 92 "required": true, |
| 93 "type": "string" |
| 94 } |
| 95 }, |
| 96 "path": "{datasetId}/allocateIds", |
| 97 "request": { |
| 98 "$ref": "AllocateIdsRequest" |
| 99 }, |
| 100 "response": { |
| 101 "$ref": "AllocateIdsResponse" |
| 102 }, |
| 103 "scopes": [ |
| 104 "https://www.googleapis.com/auth/datastore", |
| 105 "https://www.googleapis.com/auth/userinfo.email" |
| 106 ] |
| 107 }, |
| 108 "beginTransaction": { |
| 109 "description": "Begin a new transaction.", |
| 110 "httpMethod": "POST", |
| 111 "id": "datastore.datasets.beginTransaction", |
| 112 "parameterOrder": [ |
| 113 "datasetId" |
| 114 ], |
| 115 "parameters": { |
| 116 "datasetId": { |
| 117 "description": "Identifies the dataset.", |
| 118 "location": "path", |
| 119 "required": true, |
| 120 "type": "string" |
| 121 } |
| 122 }, |
| 123 "path": "{datasetId}/beginTransaction", |
| 124 "request": { |
| 125 "$ref": "BeginTransactionRequest" |
| 126 }, |
| 127 "response": { |
| 128 "$ref": "BeginTransactionResponse" |
| 129 }, |
| 130 "scopes": [ |
| 131 "https://www.googleapis.com/auth/datastore", |
| 132 "https://www.googleapis.com/auth/userinfo.email" |
| 133 ] |
| 134 }, |
| 135 "commit": { |
| 136 "description": "Commit a transaction, optionally creating, d
eleting or modifying some entities.", |
| 137 "httpMethod": "POST", |
| 138 "id": "datastore.datasets.commit", |
| 139 "parameterOrder": [ |
| 140 "datasetId" |
| 141 ], |
| 142 "parameters": { |
| 143 "datasetId": { |
| 144 "description": "Identifies the dataset.", |
| 145 "location": "path", |
| 146 "required": true, |
| 147 "type": "string" |
| 148 } |
| 149 }, |
| 150 "path": "{datasetId}/commit", |
| 151 "request": { |
| 152 "$ref": "CommitRequest" |
| 153 }, |
| 154 "response": { |
| 155 "$ref": "CommitResponse" |
| 156 }, |
| 157 "scopes": [ |
| 158 "https://www.googleapis.com/auth/datastore", |
| 159 "https://www.googleapis.com/auth/userinfo.email" |
| 160 ] |
| 161 }, |
| 162 "lookup": { |
| 163 "description": "Look up some entities by key.", |
| 164 "httpMethod": "POST", |
| 165 "id": "datastore.datasets.lookup", |
| 166 "parameterOrder": [ |
| 167 "datasetId" |
| 168 ], |
| 169 "parameters": { |
| 170 "datasetId": { |
| 171 "description": "Identifies the dataset.", |
| 172 "location": "path", |
| 173 "required": true, |
| 174 "type": "string" |
| 175 } |
| 176 }, |
| 177 "path": "{datasetId}/lookup", |
| 178 "request": { |
| 179 "$ref": "LookupRequest" |
| 180 }, |
| 181 "response": { |
| 182 "$ref": "LookupResponse" |
| 183 }, |
| 184 "scopes": [ |
| 185 "https://www.googleapis.com/auth/datastore", |
| 186 "https://www.googleapis.com/auth/userinfo.email" |
| 187 ] |
| 188 }, |
| 189 "rollback": { |
| 190 "description": "Roll back a transaction.", |
| 191 "httpMethod": "POST", |
| 192 "id": "datastore.datasets.rollback", |
| 193 "parameterOrder": [ |
| 194 "datasetId" |
| 195 ], |
| 196 "parameters": { |
| 197 "datasetId": { |
| 198 "description": "Identifies the dataset.", |
| 199 "location": "path", |
| 200 "required": true, |
| 201 "type": "string" |
| 202 } |
| 203 }, |
| 204 "path": "{datasetId}/rollback", |
| 205 "request": { |
| 206 "$ref": "RollbackRequest" |
| 207 }, |
| 208 "response": { |
| 209 "$ref": "RollbackResponse" |
| 210 }, |
| 211 "scopes": [ |
| 212 "https://www.googleapis.com/auth/datastore", |
| 213 "https://www.googleapis.com/auth/userinfo.email" |
| 214 ] |
| 215 }, |
| 216 "runQuery": { |
| 217 "description": "Query for entities.", |
| 218 "httpMethod": "POST", |
| 219 "id": "datastore.datasets.runQuery", |
| 220 "parameterOrder": [ |
| 221 "datasetId" |
| 222 ], |
| 223 "parameters": { |
| 224 "datasetId": { |
| 225 "description": "Identifies the dataset.", |
| 226 "location": "path", |
| 227 "required": true, |
| 228 "type": "string" |
| 229 } |
| 230 }, |
| 231 "path": "{datasetId}/runQuery", |
| 232 "request": { |
| 233 "$ref": "RunQueryRequest" |
| 234 }, |
| 235 "response": { |
| 236 "$ref": "RunQueryResponse" |
| 237 }, |
| 238 "scopes": [ |
| 239 "https://www.googleapis.com/auth/datastore", |
| 240 "https://www.googleapis.com/auth/userinfo.email" |
| 241 ] |
| 242 } |
| 243 } |
| 244 } |
| 245 }, |
| 246 "revision": "20140613", |
| 247 "rootUrl": "https://www.googleapis.com/", |
| 248 "schemas": { |
| 249 "AllocateIdsRequest": { |
| 250 "id": "AllocateIdsRequest", |
| 251 "properties": { |
| 252 "keys": { |
| 253 "description": "A list of keys with incomplete key paths to
allocate IDs for. No key may be reserved/read-only.", |
| 254 "items": { |
| 255 "$ref": "Key" |
| 256 }, |
| 257 "type": "array" |
| 258 } |
| 259 }, |
| 260 "type": "object" |
| 261 }, |
| 262 "AllocateIdsResponse": { |
| 263 "id": "AllocateIdsResponse", |
| 264 "properties": { |
| 265 "header": { |
| 266 "$ref": "ResponseHeader" |
| 267 }, |
| 268 "keys": { |
| 269 "description": "The keys specified in the request (in the sa
me order), each with its key path completed with a newly allocated ID.", |
| 270 "items": { |
| 271 "$ref": "Key" |
| 272 }, |
| 273 "type": "array" |
| 274 } |
| 275 }, |
| 276 "type": "object" |
| 277 }, |
| 278 "BeginTransactionRequest": { |
| 279 "id": "BeginTransactionRequest", |
| 280 "properties": { |
| 281 "isolationLevel": { |
| 282 "description": "The transaction isolation level. Either snap
shot or serializable. The default isolation level is snapshot isolation, which m
eans that another transaction may not concurrently modify the data that is modif
ied by this transaction. Optionally, a transaction can request to be made serial
izable which means that another transaction cannot concurrently modify the data
that is read or modified by this transaction.", |
| 283 "enum": [ |
| 284 "SERIALIZABLE", |
| 285 "SNAPSHOT" |
| 286 ], |
| 287 "enumDescriptions": [ |
| 288 "", |
| 289 "" |
| 290 ], |
| 291 "type": "string" |
| 292 } |
| 293 }, |
| 294 "type": "object" |
| 295 }, |
| 296 "BeginTransactionResponse": { |
| 297 "id": "BeginTransactionResponse", |
| 298 "properties": { |
| 299 "header": { |
| 300 "$ref": "ResponseHeader" |
| 301 }, |
| 302 "transaction": { |
| 303 "description": "The transaction identifier (always present).
", |
| 304 "format": "byte", |
| 305 "type": "string" |
| 306 } |
| 307 }, |
| 308 "type": "object" |
| 309 }, |
| 310 "CommitRequest": { |
| 311 "id": "CommitRequest", |
| 312 "properties": { |
| 313 "ignoreReadOnly": { |
| 314 "type": "boolean" |
| 315 }, |
| 316 "mode": { |
| 317 "description": "The type of commit to perform. Either TRANSA
CTIONAL or NON_TRANSACTIONAL.", |
| 318 "enum": [ |
| 319 "NON_TRANSACTIONAL", |
| 320 "TRANSACTIONAL" |
| 321 ], |
| 322 "enumDescriptions": [ |
| 323 "", |
| 324 "" |
| 325 ], |
| 326 "type": "string" |
| 327 }, |
| 328 "mutation": { |
| 329 "$ref": "Mutation", |
| 330 "description": "The mutation to perform. Optional." |
| 331 }, |
| 332 "transaction": { |
| 333 "description": "The transaction identifier, returned by a ca
ll to beginTransaction. Must be set when mode is TRANSACTIONAL.", |
| 334 "format": "byte", |
| 335 "type": "string" |
| 336 } |
| 337 }, |
| 338 "type": "object" |
| 339 }, |
| 340 "CommitResponse": { |
| 341 "id": "CommitResponse", |
| 342 "properties": { |
| 343 "header": { |
| 344 "$ref": "ResponseHeader" |
| 345 }, |
| 346 "mutationResult": { |
| 347 "$ref": "MutationResult", |
| 348 "description": "The result of performing the mutation (if an
y)." |
| 349 } |
| 350 }, |
| 351 "type": "object" |
| 352 }, |
| 353 "CompositeFilter": { |
| 354 "id": "CompositeFilter", |
| 355 "properties": { |
| 356 "filters": { |
| 357 "description": "The list of filters to combine. Must contain
at least one filter.", |
| 358 "items": { |
| 359 "$ref": "Filter" |
| 360 }, |
| 361 "type": "array" |
| 362 }, |
| 363 "operator": { |
| 364 "description": "The operator for combining multiple filters.
Only \"and\" is currently supported.", |
| 365 "enum": [ |
| 366 "AND" |
| 367 ], |
| 368 "enumDescriptions": [ |
| 369 "" |
| 370 ], |
| 371 "type": "string" |
| 372 } |
| 373 }, |
| 374 "type": "object" |
| 375 }, |
| 376 "Entity": { |
| 377 "id": "Entity", |
| 378 "properties": { |
| 379 "key": { |
| 380 "$ref": "Key", |
| 381 "description": "The entity's key.\n\nAn entity must have a k
ey, unless otherwise documented (for example, an entity in Value.entityValue may
have no key). An entity's kind is its key's path's last element's kind, or null
if it has no key." |
| 382 }, |
| 383 "properties": { |
| 384 "additionalProperties": { |
| 385 "$ref": "Property", |
| 386 "description": "The name of the property. A property nam
e matching regex \"__.*__\" is reserved. A reserved property name is forbidden i
n certain documented contexts. The name must not contain more than 500 character
s. Cannot be \"\"." |
| 387 }, |
| 388 "description": "The entity's properties.", |
| 389 "type": "object" |
| 390 } |
| 391 }, |
| 392 "type": "object" |
| 393 }, |
| 394 "EntityResult": { |
| 395 "id": "EntityResult", |
| 396 "properties": { |
| 397 "entity": { |
| 398 "$ref": "Entity", |
| 399 "description": "The resulting entity." |
| 400 } |
| 401 }, |
| 402 "type": "object" |
| 403 }, |
| 404 "Filter": { |
| 405 "id": "Filter", |
| 406 "properties": { |
| 407 "compositeFilter": { |
| 408 "$ref": "CompositeFilter", |
| 409 "description": "A composite filter." |
| 410 }, |
| 411 "propertyFilter": { |
| 412 "$ref": "PropertyFilter", |
| 413 "description": "A filter on a property." |
| 414 } |
| 415 }, |
| 416 "type": "object" |
| 417 }, |
| 418 "GqlQuery": { |
| 419 "id": "GqlQuery", |
| 420 "properties": { |
| 421 "allowLiteral": { |
| 422 "description": "When false, the query string must not contai
n a literal.", |
| 423 "type": "boolean" |
| 424 }, |
| 425 "nameArgs": { |
| 426 "description": "A named argument must set field GqlQueryArg.
name. No two named arguments may have the same name. For each non-reserved named
binding site in the query string, there must be a named argument with that name
, but not necessarily the inverse.", |
| 427 "items": { |
| 428 "$ref": "GqlQueryArg" |
| 429 }, |
| 430 "type": "array" |
| 431 }, |
| 432 "numberArgs": { |
| 433 "description": "Numbered binding site @1 references the firs
t numbered argument, effectively using 1-based indexing, rather than the usual 0
. A numbered argument must NOT set field GqlQueryArg.name. For each binding site
numbered i in query_string, there must be an ith numbered argument. The inverse
must also be true.", |
| 434 "items": { |
| 435 "$ref": "GqlQueryArg" |
| 436 }, |
| 437 "type": "array" |
| 438 }, |
| 439 "queryString": { |
| 440 "type": "string" |
| 441 } |
| 442 }, |
| 443 "type": "object" |
| 444 }, |
| 445 "GqlQueryArg": { |
| 446 "id": "GqlQueryArg", |
| 447 "properties": { |
| 448 "cursor": { |
| 449 "format": "byte", |
| 450 "type": "string" |
| 451 }, |
| 452 "name": { |
| 453 "description": "Must match regex \"[A-Za-z_$][A-Za-z_$0-9]*\
". Must not match regex \"__.*__\". Must not be \"\".", |
| 454 "type": "string" |
| 455 }, |
| 456 "value": { |
| 457 "$ref": "Value" |
| 458 } |
| 459 }, |
| 460 "type": "object" |
| 461 }, |
| 462 "Key": { |
| 463 "id": "Key", |
| 464 "properties": { |
| 465 "partitionId": { |
| 466 "$ref": "PartitionId", |
| 467 "description": "Entities are partitioned into subsets, curre
ntly identified by a dataset (usually implicitly specified by the project) and n
amespace ID. Queries are scoped to a single partition." |
| 468 }, |
| 469 "path": { |
| 470 "description": "The entity path. An entity path consists of
one or more elements composed of a kind and a string or numerical identifier, wh
ich identify entities. The first element identifies a root entity, the second el
ement identifies a child of the root entity, the third element a child of the se
cond entity, and so forth. The entities identified by all prefixes of the path a
re called the element's ancestors. An entity path is always fully complete: ALL
of the entity's ancestors are required to be in the path along with the entity i
dentifier itself. The only exception is that in some documented cases, the ident
ifier in the last path element (for the entity) itself may be omitted. A path ca
n never be empty. The path can have at most 100 elements.", |
| 471 "items": { |
| 472 "$ref": "KeyPathElement" |
| 473 }, |
| 474 "type": "array" |
| 475 } |
| 476 }, |
| 477 "type": "object" |
| 478 }, |
| 479 "KeyPathElement": { |
| 480 "description": "A (kind, ID/name) pair used to construct a key path.
\n\nAt most one of name or ID may be set. If either is set, the element is compl
ete. If neither is set, the element is incomplete.", |
| 481 "id": "KeyPathElement", |
| 482 "properties": { |
| 483 "id": { |
| 484 "description": "The ID of the entity. Never equal to zero. V
alues less than zero are discouraged and will not be supported in the future.", |
| 485 "format": "int64", |
| 486 "type": "string" |
| 487 }, |
| 488 "kind": { |
| 489 "description": "The kind of the entity. A kind matching rege
x \"__.*__\" is reserved/read-only. A kind must not contain more than 500 charac
ters. Cannot be \"\".", |
| 490 "type": "string" |
| 491 }, |
| 492 "name": { |
| 493 "description": "The name of the entity. A name matching rege
x \"__.*__\" is reserved/read-only. A name must not be more than 500 characters.
Cannot be \"\".", |
| 494 "type": "string" |
| 495 } |
| 496 }, |
| 497 "type": "object" |
| 498 }, |
| 499 "KindExpression": { |
| 500 "id": "KindExpression", |
| 501 "properties": { |
| 502 "name": { |
| 503 "description": "The name of the kind.", |
| 504 "type": "string" |
| 505 } |
| 506 }, |
| 507 "type": "object" |
| 508 }, |
| 509 "LookupRequest": { |
| 510 "id": "LookupRequest", |
| 511 "properties": { |
| 512 "keys": { |
| 513 "description": "Keys of entities to look up from the datasto
re.", |
| 514 "items": { |
| 515 "$ref": "Key" |
| 516 }, |
| 517 "type": "array" |
| 518 }, |
| 519 "readOptions": { |
| 520 "$ref": "ReadOptions", |
| 521 "description": "Options for this lookup request. Optional." |
| 522 } |
| 523 }, |
| 524 "type": "object" |
| 525 }, |
| 526 "LookupResponse": { |
| 527 "id": "LookupResponse", |
| 528 "properties": { |
| 529 "deferred": { |
| 530 "description": "A list of keys that were not looked up due t
o resource constraints.", |
| 531 "items": { |
| 532 "$ref": "Key" |
| 533 }, |
| 534 "type": "array" |
| 535 }, |
| 536 "found": { |
| 537 "description": "Entities found.", |
| 538 "items": { |
| 539 "$ref": "EntityResult" |
| 540 }, |
| 541 "type": "array" |
| 542 }, |
| 543 "header": { |
| 544 "$ref": "ResponseHeader" |
| 545 }, |
| 546 "missing": { |
| 547 "description": "Entities not found, with only the key popula
ted.", |
| 548 "items": { |
| 549 "$ref": "EntityResult" |
| 550 }, |
| 551 "type": "array" |
| 552 } |
| 553 }, |
| 554 "type": "object" |
| 555 }, |
| 556 "Mutation": { |
| 557 "id": "Mutation", |
| 558 "properties": { |
| 559 "delete": { |
| 560 "description": "Keys of entities to delete. Each key must ha
ve a complete key path and must not be reserved/read-only.", |
| 561 "items": { |
| 562 "$ref": "Key" |
| 563 }, |
| 564 "type": "array" |
| 565 }, |
| 566 "force": { |
| 567 "description": "Ignore a user specified read-only period. Op
tional.", |
| 568 "type": "boolean" |
| 569 }, |
| 570 "insert": { |
| 571 "description": "Entities to insert. Each inserted entity's k
ey must have a complete path and must not be reserved/read-only.", |
| 572 "items": { |
| 573 "$ref": "Entity" |
| 574 }, |
| 575 "type": "array" |
| 576 }, |
| 577 "insertAutoId": { |
| 578 "description": "Insert entities with a newly allocated ID. E
ach inserted entity's key must omit the final identifier in its path and must no
t be reserved/read-only.", |
| 579 "items": { |
| 580 "$ref": "Entity" |
| 581 }, |
| 582 "type": "array" |
| 583 }, |
| 584 "update": { |
| 585 "description": "Entities to update. Each updated entity's ke
y must have a complete path and must not be reserved/read-only.", |
| 586 "items": { |
| 587 "$ref": "Entity" |
| 588 }, |
| 589 "type": "array" |
| 590 }, |
| 591 "upsert": { |
| 592 "description": "Entities to upsert. Each upserted entity's k
ey must have a complete path and must not be reserved/read-only.", |
| 593 "items": { |
| 594 "$ref": "Entity" |
| 595 }, |
| 596 "type": "array" |
| 597 } |
| 598 }, |
| 599 "type": "object" |
| 600 }, |
| 601 "MutationResult": { |
| 602 "id": "MutationResult", |
| 603 "properties": { |
| 604 "indexUpdates": { |
| 605 "description": "Number of index writes.", |
| 606 "format": "int32", |
| 607 "type": "integer" |
| 608 }, |
| 609 "insertAutoIdKeys": { |
| 610 "description": "Keys for insertAutoId entities. One per enti
ty from the request, in the same order.", |
| 611 "items": { |
| 612 "$ref": "Key" |
| 613 }, |
| 614 "type": "array" |
| 615 } |
| 616 }, |
| 617 "type": "object" |
| 618 }, |
| 619 "PartitionId": { |
| 620 "id": "PartitionId", |
| 621 "properties": { |
| 622 "datasetId": { |
| 623 "description": "The dataset ID.", |
| 624 "type": "string" |
| 625 }, |
| 626 "namespace": { |
| 627 "description": "The namespace.", |
| 628 "type": "string" |
| 629 } |
| 630 }, |
| 631 "type": "object" |
| 632 }, |
| 633 "Property": { |
| 634 "id": "Property", |
| 635 "properties": { |
| 636 "blobKeyValue": { |
| 637 "description": "A blob key value.", |
| 638 "type": "string" |
| 639 }, |
| 640 "blobValue": { |
| 641 "description": "A blob value. May be a maximum of 1,000,000
bytes.", |
| 642 "format": "byte", |
| 643 "type": "string" |
| 644 }, |
| 645 "booleanValue": { |
| 646 "description": "A boolean value.", |
| 647 "type": "boolean" |
| 648 }, |
| 649 "dateTimeValue": { |
| 650 "description": "A timestamp value.", |
| 651 "format": "date-time", |
| 652 "type": "string" |
| 653 }, |
| 654 "doubleValue": { |
| 655 "description": "A double value.", |
| 656 "format": "double", |
| 657 "type": "number" |
| 658 }, |
| 659 "entityValue": { |
| 660 "$ref": "Entity", |
| 661 "description": "An entity value. May have no key. May have a
key with an incomplete key path. May have a reserved/read-only key." |
| 662 }, |
| 663 "indexed": { |
| 664 "description": "If the value should be indexed.\n\nThe index
ed property may be set for a null value. When indexed is true, stringValue is li
mited to 500 characters and the blob value is limited to 500 bytes. Input values
by default have indexed set to true; however, you can explicitly set indexed to
true if you want. (An output value never has indexed explicitly set to true.) I
f a value is itself an entity, it cannot have indexed set to true.", |
| 665 "type": "boolean" |
| 666 }, |
| 667 "integerValue": { |
| 668 "description": "An integer value.", |
| 669 "format": "int64", |
| 670 "type": "string" |
| 671 }, |
| 672 "keyValue": { |
| 673 "$ref": "Key", |
| 674 "description": "A key value." |
| 675 }, |
| 676 "listValue": { |
| 677 "description": "A list value. Cannot contain another list va
lue. Cannot also have a meaning and indexing set.", |
| 678 "items": { |
| 679 "$ref": "Value" |
| 680 }, |
| 681 "type": "array" |
| 682 }, |
| 683 "meaning": { |
| 684 "description": "The meaning field is reserved and should not
be used.", |
| 685 "format": "int32", |
| 686 "type": "integer" |
| 687 }, |
| 688 "stringValue": { |
| 689 "description": "A UTF-8 encoded string value.", |
| 690 "type": "string" |
| 691 } |
| 692 }, |
| 693 "type": "object" |
| 694 }, |
| 695 "PropertyExpression": { |
| 696 "id": "PropertyExpression", |
| 697 "properties": { |
| 698 "aggregationFunction": { |
| 699 "description": "The aggregation function to apply to the pro
perty. Optional. Can only be used when grouping by at least one property. Must t
hen be set on all properties in the projection that are not being grouped by. Ag
gregation functions: first selects the first result as determined by the query's
order.", |
| 700 "enum": [ |
| 701 "FIRST" |
| 702 ], |
| 703 "enumDescriptions": [ |
| 704 "" |
| 705 ], |
| 706 "type": "string" |
| 707 }, |
| 708 "property": { |
| 709 "$ref": "PropertyReference", |
| 710 "description": "The property to project." |
| 711 } |
| 712 }, |
| 713 "type": "object" |
| 714 }, |
| 715 "PropertyFilter": { |
| 716 "id": "PropertyFilter", |
| 717 "properties": { |
| 718 "operator": { |
| 719 "description": "The operator to filter by. One of lessThan,
lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.", |
| 720 "enum": [ |
| 721 "EQUAL", |
| 722 "GREATER_THAN", |
| 723 "GREATER_THAN_OR_EQUAL", |
| 724 "HAS_ANCESTOR", |
| 725 "LESS_THAN", |
| 726 "LESS_THAN_OR_EQUAL" |
| 727 ], |
| 728 "enumDescriptions": [ |
| 729 "", |
| 730 "", |
| 731 "", |
| 732 "", |
| 733 "", |
| 734 "" |
| 735 ], |
| 736 "type": "string" |
| 737 }, |
| 738 "property": { |
| 739 "$ref": "PropertyReference", |
| 740 "description": "The property to filter by." |
| 741 }, |
| 742 "value": { |
| 743 "$ref": "Value", |
| 744 "description": "The value to compare the property to." |
| 745 } |
| 746 }, |
| 747 "type": "object" |
| 748 }, |
| 749 "PropertyOrder": { |
| 750 "id": "PropertyOrder", |
| 751 "properties": { |
| 752 "direction": { |
| 753 "description": "The direction to order by. One of ascending
or descending. Optional, defaults to ascending.", |
| 754 "enum": [ |
| 755 "ASCENDING", |
| 756 "DESCENDING" |
| 757 ], |
| 758 "enumDescriptions": [ |
| 759 "", |
| 760 "" |
| 761 ], |
| 762 "type": "string" |
| 763 }, |
| 764 "property": { |
| 765 "$ref": "PropertyReference", |
| 766 "description": "The property to order by." |
| 767 } |
| 768 }, |
| 769 "type": "object" |
| 770 }, |
| 771 "PropertyReference": { |
| 772 "id": "PropertyReference", |
| 773 "properties": { |
| 774 "name": { |
| 775 "description": "The name of the property.", |
| 776 "type": "string" |
| 777 } |
| 778 }, |
| 779 "type": "object" |
| 780 }, |
| 781 "Query": { |
| 782 "id": "Query", |
| 783 "properties": { |
| 784 "endCursor": { |
| 785 "description": "An ending point for the query results. Optio
nal. Query cursors are returned in query result batches.", |
| 786 "format": "byte", |
| 787 "type": "string" |
| 788 }, |
| 789 "filter": { |
| 790 "$ref": "Filter", |
| 791 "description": "The filter to apply (optional)." |
| 792 }, |
| 793 "groupBy": { |
| 794 "description": "The properties to group by (if empty, no gro
uping is applied to the result set).", |
| 795 "items": { |
| 796 "$ref": "PropertyReference" |
| 797 }, |
| 798 "type": "array" |
| 799 }, |
| 800 "kinds": { |
| 801 "description": "The kinds to query (if empty, returns entiti
es from all kinds).", |
| 802 "items": { |
| 803 "$ref": "KindExpression" |
| 804 }, |
| 805 "type": "array" |
| 806 }, |
| 807 "limit": { |
| 808 "description": "The maximum number of results to return. App
lies after all other constraints. Optional.", |
| 809 "format": "int32", |
| 810 "type": "integer" |
| 811 }, |
| 812 "offset": { |
| 813 "description": "The number of results to skip. Applies befor
e limit, but after all other constraints (optional, defaults to 0).", |
| 814 "format": "int32", |
| 815 "type": "integer" |
| 816 }, |
| 817 "order": { |
| 818 "description": "The order to apply to the query results (if
empty, order is unspecified).", |
| 819 "items": { |
| 820 "$ref": "PropertyOrder" |
| 821 }, |
| 822 "type": "array" |
| 823 }, |
| 824 "projection": { |
| 825 "description": "The projection to return. If not set the ent
ire entity is returned.", |
| 826 "items": { |
| 827 "$ref": "PropertyExpression" |
| 828 }, |
| 829 "type": "array" |
| 830 }, |
| 831 "startCursor": { |
| 832 "description": "A starting point for the query results. Opti
onal. Query cursors are returned in query result batches.", |
| 833 "format": "byte", |
| 834 "type": "string" |
| 835 } |
| 836 }, |
| 837 "type": "object" |
| 838 }, |
| 839 "QueryResultBatch": { |
| 840 "id": "QueryResultBatch", |
| 841 "properties": { |
| 842 "endCursor": { |
| 843 "description": "A cursor that points to the position after t
he last result in the batch. May be absent.", |
| 844 "format": "byte", |
| 845 "type": "string" |
| 846 }, |
| 847 "entityResultType": { |
| 848 "description": "The result type for every entity in entityRe
sults. full for full entities, projection for entities with only projected prope
rties, keyOnly for entities with only a key.", |
| 849 "enum": [ |
| 850 "FULL", |
| 851 "KEY_ONLY", |
| 852 "PROJECTION" |
| 853 ], |
| 854 "enumDescriptions": [ |
| 855 "", |
| 856 "", |
| 857 "" |
| 858 ], |
| 859 "type": "string" |
| 860 }, |
| 861 "entityResults": { |
| 862 "description": "The results for this batch.", |
| 863 "items": { |
| 864 "$ref": "EntityResult" |
| 865 }, |
| 866 "type": "array" |
| 867 }, |
| 868 "moreResults": { |
| 869 "description": "The state of the query after the current bat
ch. One of notFinished, moreResultsAfterLimit, noMoreResults.", |
| 870 "enum": [ |
| 871 "MORE_RESULTS_AFTER_LIMIT", |
| 872 "NOT_FINISHED", |
| 873 "NO_MORE_RESULTS" |
| 874 ], |
| 875 "enumDescriptions": [ |
| 876 "", |
| 877 "", |
| 878 "" |
| 879 ], |
| 880 "type": "string" |
| 881 }, |
| 882 "skippedResults": { |
| 883 "description": "The number of results skipped because of Que
ry.offset.", |
| 884 "format": "int32", |
| 885 "type": "integer" |
| 886 } |
| 887 }, |
| 888 "type": "object" |
| 889 }, |
| 890 "ReadOptions": { |
| 891 "id": "ReadOptions", |
| 892 "properties": { |
| 893 "readConsistency": { |
| 894 "description": "The read consistency to use. One of default,
strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor
queries default to strong, global queries default to eventual and cannot be set
to strong. Optional. Default is default.", |
| 895 "enum": [ |
| 896 "DEFAULT", |
| 897 "EVENTUAL", |
| 898 "STRONG" |
| 899 ], |
| 900 "enumDescriptions": [ |
| 901 "", |
| 902 "", |
| 903 "" |
| 904 ], |
| 905 "type": "string" |
| 906 }, |
| 907 "transaction": { |
| 908 "description": "The transaction to use. Optional.", |
| 909 "format": "byte", |
| 910 "type": "string" |
| 911 } |
| 912 }, |
| 913 "type": "object" |
| 914 }, |
| 915 "ResponseHeader": { |
| 916 "id": "ResponseHeader", |
| 917 "properties": { |
| 918 "kind": { |
| 919 "default": "datastore#responseHeader", |
| 920 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"datastore#responseHeader\".", |
| 921 "type": "string" |
| 922 } |
| 923 }, |
| 924 "type": "object" |
| 925 }, |
| 926 "RollbackRequest": { |
| 927 "id": "RollbackRequest", |
| 928 "properties": { |
| 929 "transaction": { |
| 930 "description": "The transaction identifier, returned by a ca
ll to beginTransaction.", |
| 931 "format": "byte", |
| 932 "type": "string" |
| 933 } |
| 934 }, |
| 935 "type": "object" |
| 936 }, |
| 937 "RollbackResponse": { |
| 938 "id": "RollbackResponse", |
| 939 "properties": { |
| 940 "header": { |
| 941 "$ref": "ResponseHeader" |
| 942 } |
| 943 }, |
| 944 "type": "object" |
| 945 }, |
| 946 "RunQueryRequest": { |
| 947 "id": "RunQueryRequest", |
| 948 "properties": { |
| 949 "gqlQuery": { |
| 950 "$ref": "GqlQuery", |
| 951 "description": "The GQL query to run. Either this field or f
ield query must be set, but not both." |
| 952 }, |
| 953 "partitionId": { |
| 954 "$ref": "PartitionId", |
| 955 "description": "Entities are partitioned into subsets, ident
ified by a dataset (usually implicitly specified by the project) and namespace I
D. Queries are scoped to a single partition. This partition ID is normalized wit
h the standard default context partition ID, but all other partition IDs in RunQ
ueryRequest are normalized with this partition ID as the context partition ID." |
| 956 }, |
| 957 "query": { |
| 958 "$ref": "Query", |
| 959 "description": "The query to run. Either this field or field
gql_query must be set, but not both." |
| 960 }, |
| 961 "readOptions": { |
| 962 "$ref": "ReadOptions", |
| 963 "description": "The options for this query." |
| 964 } |
| 965 }, |
| 966 "type": "object" |
| 967 }, |
| 968 "RunQueryResponse": { |
| 969 "id": "RunQueryResponse", |
| 970 "properties": { |
| 971 "batch": { |
| 972 "$ref": "QueryResultBatch", |
| 973 "description": "A batch of query results (always present)." |
| 974 }, |
| 975 "header": { |
| 976 "$ref": "ResponseHeader" |
| 977 } |
| 978 }, |
| 979 "type": "object" |
| 980 }, |
| 981 "Value": { |
| 982 "id": "Value", |
| 983 "properties": { |
| 984 "blobKeyValue": { |
| 985 "description": "A blob key value.", |
| 986 "type": "string" |
| 987 }, |
| 988 "blobValue": { |
| 989 "description": "A blob value. May be a maximum of 1,000,000
bytes.", |
| 990 "format": "byte", |
| 991 "type": "string" |
| 992 }, |
| 993 "booleanValue": { |
| 994 "description": "A boolean value.", |
| 995 "type": "boolean" |
| 996 }, |
| 997 "dateTimeValue": { |
| 998 "description": "A timestamp value.", |
| 999 "format": "date-time", |
| 1000 "type": "string" |
| 1001 }, |
| 1002 "doubleValue": { |
| 1003 "description": "A double value.", |
| 1004 "format": "double", |
| 1005 "type": "number" |
| 1006 }, |
| 1007 "entityValue": { |
| 1008 "$ref": "Entity", |
| 1009 "description": "An entity value. May have no key. May have a
key with an incomplete key path. May have a reserved/read-only key." |
| 1010 }, |
| 1011 "indexed": { |
| 1012 "description": "If the value should be indexed.\n\nThe index
ed property may be set for a null value. When indexed is true, stringValue is li
mited to 500 characters and the blob value is limited to 500 bytes. Input values
by default have indexed set to true; however, you can explicitly set indexed to
true if you want. (An output value never has indexed explicitly set to true.) I
f a value is itself an entity, it cannot have indexed set to true.", |
| 1013 "type": "boolean" |
| 1014 }, |
| 1015 "integerValue": { |
| 1016 "description": "An integer value.", |
| 1017 "format": "int64", |
| 1018 "type": "string" |
| 1019 }, |
| 1020 "keyValue": { |
| 1021 "$ref": "Key", |
| 1022 "description": "A key value." |
| 1023 }, |
| 1024 "listValue": { |
| 1025 "description": "A list value. Cannot contain another list va
lue. Cannot also have a meaning and indexing set.", |
| 1026 "items": { |
| 1027 "$ref": "Value" |
| 1028 }, |
| 1029 "type": "array" |
| 1030 }, |
| 1031 "meaning": { |
| 1032 "description": "The meaning field is reserved and should not
be used.", |
| 1033 "format": "int32", |
| 1034 "type": "integer" |
| 1035 }, |
| 1036 "stringValue": { |
| 1037 "description": "A UTF-8 encoded string value.", |
| 1038 "type": "string" |
| 1039 } |
| 1040 }, |
| 1041 "type": "object" |
| 1042 } |
| 1043 }, |
| 1044 "servicePath": "datastore/v1beta2/datasets/", |
| 1045 "title": "Google Cloud Datastore API", |
| 1046 "version": "v1beta2" |
| 1047 } |
OLD | NEW |