Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(492)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/datastore__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/dataproc__v1beta2.json ('k') | discovery/googleapis/dns__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/datastore__v1.json
diff --git a/discovery/googleapis/datastore__v1.json b/discovery/googleapis/datastore__v1.json
index d04368efb1cab0728355e17930b37a53746b77e0..d122789d65c051d9ed688b009007741faec56568 100644
--- a/discovery/googleapis/datastore__v1.json
+++ b/discovery/googleapis/datastore__v1.json
@@ -27,53 +27,16 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
- "location": "query",
- "type": "string"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -95,11 +58,6 @@
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
"$.xgafv": {
"description": "V1 error format.",
"enum": [
@@ -112,39 +70,54 @@
],
"location": "query",
"type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
- "allocateIds": {
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
- "httpMethod": "POST",
- "id": "datastore.projects.allocateIds",
- "parameterOrder": [
- "projectId"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/projects/{projectId}:allocateIds",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ]
- },
"beginTransaction": {
"description": "Begins a new transaction.",
"httpMethod": "POST",
@@ -279,19 +252,58 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
+ },
+ "allocateIds": {
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "httpMethod": "POST",
+ "id": "datastore.projects.allocateIds",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/projects/{projectId}:allocateIds",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ },
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ]
}
}
}
},
- "revision": "20170626",
+ "revision": "20170711",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
- "AllocateIdsResponse": {
- "description": "The response for Datastore.AllocateIds.",
- "id": "AllocateIdsResponse",
+ "BeginTransactionResponse": {
+ "description": "The response for Datastore.BeginTransaction.",
+ "id": "BeginTransactionResponse",
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier (always present).",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AllocateIdsRequest": {
+ "description": "The request for Datastore.AllocateIds.",
+ "id": "AllocateIdsRequest",
"properties": {
"keys": {
- "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
"items": {
"$ref": "Key"
},
@@ -300,385 +312,386 @@
},
"type": "object"
},
- "Query": {
- "description": "A query for entities.",
- "id": "Query",
+ "LookupResponse": {
+ "description": "The response for Datastore.Lookup.",
+ "id": "LookupResponse",
"properties": {
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "items": {
- "$ref": "Projection"
- },
- "type": "array"
- },
- "endCursor": {
- "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
- },
- "limit": {
- "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be >= 0 if specified.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
- "offset": {
- "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be >= 0 if specified.",
- "format": "int32",
- "type": "integer"
- },
- "startCursor": {
- "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
- },
- "kind": {
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
"items": {
- "$ref": "KindExpression"
+ "$ref": "Key"
},
"type": "array"
},
- "distinctOn": {
- "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
+ "missing": {
+ "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
"items": {
- "$ref": "PropertyReference"
+ "$ref": "EntityResult"
},
"type": "array"
},
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "found": {
+ "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
"items": {
- "$ref": "PropertyOrder"
+ "$ref": "EntityResult"
},
"type": "array"
}
},
"type": "object"
},
- "PropertyFilter": {
- "description": "A filter on a specific property.",
- "id": "PropertyFilter",
+ "RunQueryResponse": {
+ "description": "The response for Datastore.RunQuery.",
+ "id": "RunQueryResponse",
"properties": {
- "value": {
- "$ref": "Value",
- "description": "The value to compare the property to."
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "query": {
+ "$ref": "Query",
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set."
},
- "op": {
- "description": "The operator to filter by.",
+ "batch": {
+ "$ref": "QueryResultBatch",
+ "description": "A batch of query results (always present)."
+ }
+ },
+ "type": "object"
+ },
+ "CommitRequest": {
+ "description": "The request for Datastore.Commit.",
+ "id": "CommitRequest",
+ "properties": {
+ "mode": {
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
"enum": [
- "OPERATOR_UNSPECIFIED",
- "LESS_THAN",
- "LESS_THAN_OR_EQUAL",
- "GREATER_THAN",
- "GREATER_THAN_OR_EQUAL",
- "EQUAL",
- "HAS_ANCESTOR"
- ],
+ "MODE_UNSPECIFIED",
+ "TRANSACTIONAL",
+ "NON_TRANSACTIONAL"
+ ],
"enumDescriptions": [
"Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
+ "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
+ "Non-transactional: The mutations may not apply as all or none."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "EntityResult": {
- "description": "The result of fetching an entity from Datastore.",
- "id": "EntityResult",
- "properties": {
- "cursor": {
- "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
- "format": "byte",
- "type": "string"
},
- "version": {
- "description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field 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.",
- "format": "int64",
- "type": "string"
- },
- "entity": {
- "$ref": "Entity",
- "description": "The resulting entity."
- }
- },
- "type": "object"
- },
- "CommitResponse": {
- "description": "The response for Datastore.Commit.",
- "id": "CommitResponse",
- "properties": {
- "mutationResults": {
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
"items": {
- "$ref": "MutationResult"
+ "$ref": "Mutation"
},
"type": "array"
},
- "indexUpdates": {
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
- "format": "int32",
- "type": "integer"
+ "transaction": {
+ "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
}
},
"type": "object"
},
- "Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "id": "Value",
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "id": "BeginTransactionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "PropertyOrder": {
+ "description": "The desired order for a specific property.",
+ "id": "PropertyOrder",
"properties": {
- "timestampValue": {
- "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
- "format": "google-datetime",
- "type": "string"
- },
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "nullValue": {
- "description": "A null value.",
+ "direction": {
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
"enum": [
- "NULL_VALUE"
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
],
"enumDescriptions": [
- "Null value."
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
],
"type": "string"
},
- "blobValue": {
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "format": "byte",
- "type": "string"
- },
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
- },
- "arrayValue": {
- "$ref": "ArrayValue",
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "integerValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "stringValue": {
- "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
+ }
+ },
+ "type": "object"
+ },
+ "KindExpression": {
+ "description": "A representation of a kind.",
+ "id": "KindExpression",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This 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 longitude 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 return 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], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(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) == NormalizeLatLng(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 assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "id": "LatLng",
+ "properties": {
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
},
- "excludeFromIndexes": {
- "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
- "type": "boolean"
- },
- "doubleValue": {
- "description": "A double value.",
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
},
- "PartitionId": {
- "description": "A partition ID identifies a grouping of entities. The 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 project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
- "id": "PartitionId",
+ "Key": {
+ "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "id": "Key",
"properties": {
- "projectId": {
- "description": "The ID of the project to which the entities belong.",
- "type": "string"
+ "path": {
+ "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 second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always 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 some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "items": {
+ "$ref": "PathElement"
+ },
+ "type": "array"
},
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
}
},
"type": "object"
},
- "Entity": {
- "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.",
- "id": "Entity",
+ "PropertyReference": {
+ "description": "A reference to a property relative to the kind expressions.",
+ "id": "PropertyReference",
"properties": {
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, 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."
- },
- "properties": {
- "additionalProperties": {
- "$ref": "Value"
- },
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object"
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
}
},
"type": "object"
},
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "id": "LookupRequest",
+ "ArrayValue": {
+ "description": "An array value.",
+ "id": "ArrayValue",
"properties": {
- "keys": {
- "description": "Keys of entities to look up.",
+ "values": {
+ "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
"items": {
- "$ref": "Key"
+ "$ref": "Value"
},
"type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Projection": {
+ "description": "A representation of a property in a projection.",
+ "id": "Projection",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "type": "object"
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "id": "Mutation",
+ "properties": {
+ "delete": {
+ "$ref": "Key",
+ "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 reserved/read-only."
},
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this lookup request."
+ "baseVersion": {
+ "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "insert": {
+ "$ref": "Entity",
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "update": {
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
+ },
+ "upsert": {
+ "$ref": "Entity",
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
}
},
"type": "object"
},
- "QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "id": "QueryResultBatch",
+ "ReadOptions": {
+ "description": "The options shared by read requests.",
+ "id": "ReadOptions",
"properties": {
- "skippedCursor": {
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "transaction": {
+ "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
"format": "byte",
"type": "string"
},
- "skippedResults": {
- "description": "The number of results skipped, typically because of an offset.",
- "format": "int32",
- "type": "integer"
- },
- "entityResultType": {
- "description": "The result type for every entity in `entity_results`.",
+ "readConsistency": {
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
"enum": [
- "RESULT_TYPE_UNSPECIFIED",
- "FULL",
- "PROJECTION",
- "KEY_ONLY"
+ "READ_CONSISTENCY_UNSPECIFIED",
+ "STRONG",
+ "EVENTUAL"
],
"enumDescriptions": [
- "Unspecified. This value is never used.",
- "The key and properties.",
- "A projected subset of properties. The entity may have no key.",
- "Only the key."
+ "Unspecified. This value must not be used.",
+ "Strong consistency.",
+ "Eventual consistency."
],
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RollbackResponse": {
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "id": "RollbackResponse",
+ "properties": {},
+ "type": "object"
+ },
+ "MutationResult": {
+ "description": "The result of applying a mutation.",
+ "id": "MutationResult",
+ "properties": {
+ "key": {
+ "$ref": "Key",
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
},
- "entityResults": {
- "description": "The results for this batch.",
+ "version": {
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "format": "int64",
+ "type": "string"
+ },
+ "conflictDetected": {
+ "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "GqlQuery": {
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "id": "GqlQuery",
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "positionalBindings": {
+ "description": "Numbered binding site @1 references the first 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.",
"items": {
- "$ref": "EntityResult"
+ "$ref": "GqlQueryParameter"
},
"type": "array"
},
- "moreResults": {
- "description": "The state of the query after the current batch.",
- "enum": [
- "MORE_RESULTS_TYPE_UNSPECIFIED",
- "NOT_FINISHED",
- "MORE_RESULTS_AFTER_LIMIT",
- "MORE_RESULTS_AFTER_CURSOR",
- "NO_MORE_RESULTS"
- ],
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "There may be additional batches to fetch from this query.",
- "The query is finished, but there may be more results after the limit.",
- "The query is finished, but there may be more results after the end\ncursor.",
- "The query has been exhausted."
- ],
- "type": "string"
- },
- "endCursor": {
- "description": "A cursor that points to the position after the last result in the batch.",
- "format": "byte",
- "type": "string"
+ "namedBindings": {
+ "additionalProperties": {
+ "$ref": "GqlQueryParameter"
+ },
+ "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
+ "type": "object"
},
- "snapshotVersion": {
- "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_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, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
- "format": "int64",
- "type": "string"
+ "allowLiterals": {
+ "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
+ "type": "boolean"
}
},
"type": "object"
},
- "PathElement": {
- "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, the element is incomplete.",
- "id": "PathElement",
+ "Filter": {
+ "description": "A holder for any type of filter.",
+ "id": "Filter",
"properties": {
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "id": {
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "format": "int64",
- "type": "string"
+ "compositeFilter": {
+ "$ref": "CompositeFilter",
+ "description": "A composite filter."
},
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
+ "propertyFilter": {
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
}
},
"type": "object"
},
- "GqlQueryParameter": {
- "description": "A binding parameter for a GQL query.",
- "id": "GqlQueryParameter",
+ "RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "id": "RollbackRequest",
"properties": {
- "cursor": {
- "description": "A query cursor. Query cursors are returned in query\nresult batches.",
+ "transaction": {
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
"format": "byte",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "id": "RunQueryRequest",
+ "properties": {
+ "gqlQuery": {
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
},
- "value": {
- "$ref": "Value",
- "description": "A value parameter."
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ },
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this query."
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The query to run."
}
},
"type": "object"
},
- "BeginTransactionResponse": {
- "description": "The response for Datastore.BeginTransaction.",
- "id": "BeginTransactionResponse",
+ "CompositeFilter": {
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "id": "CompositeFilter",
"properties": {
- "transaction": {
- "description": "The transaction identifier (always present).",
- "format": "byte",
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
+ "op": {
+ "description": "The operator for combining multiple filters.",
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "AND"
+ ],
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "The results are required to satisfy each of the combined filters."
+ ],
"type": "string"
}
},
"type": "object"
},
- "AllocateIdsRequest": {
- "description": "The request for Datastore.AllocateIds.",
- "id": "AllocateIdsRequest",
+ "AllocateIdsResponse": {
+ "description": "The response for Datastore.AllocateIds.",
+ "id": "AllocateIdsResponse",
"properties": {
"keys": {
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
"items": {
"$ref": "Key"
},
@@ -687,375 +700,362 @@
},
"type": "object"
},
- "LookupResponse": {
- "description": "The response for Datastore.Lookup.",
- "id": "LookupResponse",
+ "Query": {
+ "description": "A query for entities.",
+ "id": "Query",
"properties": {
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "kind": {
+ "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
"items": {
- "$ref": "Key"
+ "$ref": "KindExpression"
},
"type": "array"
},
- "missing": {
- "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
+ "distinctOn": {
+ "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
"items": {
- "$ref": "EntityResult"
+ "$ref": "PropertyReference"
},
"type": "array"
},
- "found": {
- "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
"items": {
- "$ref": "EntityResult"
+ "$ref": "PropertyOrder"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "RunQueryResponse": {
- "description": "The response for Datastore.RunQuery.",
- "id": "RunQueryResponse",
- "properties": {
- "batch": {
- "$ref": "QueryResultBatch",
- "description": "A batch of query results (always present)."
},
- "query": {
- "$ref": "Query",
- "description": "The parsed form of the `GqlQuery` from the request, if it was set."
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "items": {
+ "$ref": "Projection"
+ },
+ "type": "array"
+ },
+ "endCursor": {
+ "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
+ },
+ "limit": {
+ "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be >= 0 if specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "$ref": "Filter",
+ "description": "The filter to apply."
+ },
+ "offset": {
+ "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be >= 0 if specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startCursor": {
+ "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
}
},
"type": "object"
},
- "PropertyOrder": {
- "description": "The desired order for a specific property.",
- "id": "PropertyOrder",
+ "PropertyFilter": {
+ "description": "A filter on a specific property.",
+ "id": "PropertyFilter",
"properties": {
- "direction": {
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ],
- "type": "string"
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
},
"property": {
"$ref": "PropertyReference",
- "description": "The property to order by."
- }
- },
- "type": "object"
- },
- "BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "id": "BeginTransactionRequest",
- "properties": {},
- "type": "object"
- },
- "CommitRequest": {
- "description": "The request for Datastore.Commit.",
- "id": "CommitRequest",
- "properties": {
- "transaction": {
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
+ "description": "The property to filter by."
},
- "mode": {
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
+ "op": {
+ "description": "The operator to filter by.",
"enum": [
- "MODE_UNSPECIFIED",
- "TRANSACTIONAL",
- "NON_TRANSACTIONAL"
+ "OPERATOR_UNSPECIFIED",
+ "LESS_THAN",
+ "LESS_THAN_OR_EQUAL",
+ "GREATER_THAN",
+ "GREATER_THAN_OR_EQUAL",
+ "EQUAL",
+ "HAS_ANCESTOR"
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
- "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
- "Non-transactional: The mutations may not apply as all or none."
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
],
"type": "string"
- },
- "mutations": {
- "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
- "items": {
- "$ref": "Mutation"
- },
- "type": "array"
}
},
"type": "object"
},
- "KindExpression": {
- "description": "A representation of a kind.",
- "id": "KindExpression",
+ "EntityResult": {
+ "description": "The result of fetching an entity from Datastore.",
+ "id": "EntityResult",
"properties": {
- "name": {
- "description": "The name of the kind.",
+ "cursor": {
+ "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
+ "format": "byte",
"type": "string"
- }
- },
- "type": "object"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This 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 longitude 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 return 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], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(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) == NormalizeLatLng(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 assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "id": "LatLng",
- "properties": {
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double",
- "type": "number"
},
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double",
- "type": "number"
+ "version": {
+ "description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field 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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "entity": {
+ "$ref": "Entity",
+ "description": "The resulting entity."
}
},
"type": "object"
},
- "Key": {
- "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
- "id": "Key",
+ "CommitResponse": {
+ "description": "The response for Datastore.Commit.",
+ "id": "CommitResponse",
"properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ "indexUpdates": {
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "format": "int32",
+ "type": "integer"
},
- "path": {
- "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 second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always 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 some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
"items": {
- "$ref": "PathElement"
+ "$ref": "MutationResult"
},
"type": "array"
}
},
"type": "object"
},
- "PropertyReference": {
- "description": "A reference to a property relative to the kind expressions.",
- "id": "PropertyReference",
+ "Value": {
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "id": "Value",
"properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "booleanValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "nullValue": {
+ "description": "A null value.",
+ "enum": [
+ "NULL_VALUE"
+ ],
+ "enumDescriptions": [
+ "Null value."
+ ],
+ "type": "string"
+ },
+ "blobValue": {
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "meaning": {
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "arrayValue": {
+ "$ref": "ArrayValue",
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
+ },
+ "entityValue": {
+ "$ref": "Entity",
+ "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
+ },
+ "integerValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "keyValue": {
+ "$ref": "Key",
+ "description": "A key value."
+ },
+ "stringValue": {
+ "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
+ "type": "string"
+ },
+ "excludeFromIndexes": {
+ "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
+ "type": "boolean"
+ },
+ "doubleValue": {
+ "description": "A double value.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestampValue": {
+ "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
+ "format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
- "Projection": {
- "description": "A representation of a property in a projection.",
- "id": "Projection",
+ "PartitionId": {
+ "description": "A partition ID identifies a grouping of entities. The 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 project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
+ "id": "PartitionId",
"properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project to which the entities belong.",
+ "type": "string"
}
},
"type": "object"
},
- "ArrayValue": {
- "description": "An array value.",
- "id": "ArrayValue",
+ "Entity": {
+ "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.",
+ "id": "Entity",
"properties": {
- "values": {
- "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
- "items": {
+ "key": {
+ "$ref": "Key",
+ "description": "The entity's key.\n\nAn entity must have a key, 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."
+ },
+ "properties": {
+ "additionalProperties": {
"$ref": "Value"
},
- "type": "array"
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
}
},
"type": "object"
},
- "Mutation": {
- "description": "A mutation to apply to an entity.",
- "id": "Mutation",
+ "QueryResultBatch": {
+ "description": "A batch of results produced by a query.",
+ "id": "QueryResultBatch",
"properties": {
- "baseVersion": {
- "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.",
+ "snapshotVersion": {
+ "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_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, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
"format": "int64",
"type": "string"
},
- "insert": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
- },
- "update": {
- "$ref": "Entity",
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
- },
- "upsert": {
- "$ref": "Entity",
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
- },
- "delete": {
- "$ref": "Key",
- "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 reserved/read-only."
- }
- },
- "type": "object"
- },
- "ReadOptions": {
- "description": "The options shared by read requests.",
- "id": "ReadOptions",
- "properties": {
- "transaction": {
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "skippedCursor": {
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
"format": "byte",
"type": "string"
},
- "readConsistency": {
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "skippedResults": {
+ "description": "The number of results skipped, typically because of an offset.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "entityResultType": {
+ "description": "The result type for every entity in `entity_results`.",
"enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
+ "RESULT_TYPE_UNSPECIFIED",
+ "FULL",
+ "PROJECTION",
+ "KEY_ONLY"
],
"enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
+ "Unspecified. This value is never used.",
+ "The key and properties.",
+ "A projected subset of properties. The entity may have no key.",
+ "Only the key."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "RollbackResponse": {
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "id": "RollbackResponse",
- "properties": {},
- "type": "object"
- },
- "MutationResult": {
- "description": "The result of applying a mutation.",
- "id": "MutationResult",
- "properties": {
- "conflictDetected": {
- "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
- "type": "boolean"
- },
- "key": {
- "$ref": "Key",
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
- },
- "version": {
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GqlQuery": {
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "id": "GqlQuery",
- "properties": {
- "queryString": {
- "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "string"
},
- "positionalBindings": {
- "description": "Numbered binding site @1 references the first 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.",
+ "entityResults": {
+ "description": "The results for this batch.",
"items": {
- "$ref": "GqlQueryParameter"
+ "$ref": "EntityResult"
},
"type": "array"
},
- "namedBindings": {
- "additionalProperties": {
- "$ref": "GqlQueryParameter"
- },
- "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
- "type": "object"
+ "endCursor": {
+ "description": "A cursor that points to the position after the last result in the batch.",
+ "format": "byte",
+ "type": "string"
},
- "allowLiterals": {
- "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
- "type": "boolean"
+ "moreResults": {
+ "description": "The state of the query after the current batch.",
+ "enum": [
+ "MORE_RESULTS_TYPE_UNSPECIFIED",
+ "NOT_FINISHED",
+ "MORE_RESULTS_AFTER_LIMIT",
+ "MORE_RESULTS_AFTER_CURSOR",
+ "NO_MORE_RESULTS"
+ ],
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "There may be additional batches to fetch from this query.",
+ "The query is finished, but there may be more results after the limit.",
+ "The query is finished, but there may be more results after the end\ncursor.",
+ "The query is finished, and there are no more results."
+ ],
+ "type": "string"
}
},
"type": "object"
},
- "Filter": {
- "description": "A holder for any type of filter.",
- "id": "Filter",
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
+ "id": "LookupRequest",
"properties": {
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
},
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
}
},
"type": "object"
},
- "RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "id": "RollbackRequest",
+ "PathElement": {
+ "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, the element is incomplete.",
+ "id": "PathElement",
"properties": {
- "transaction": {
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
+ "id": {
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "format": "int64",
"type": "string"
- }
- },
- "type": "object"
- },
- "RunQueryRequest": {
- "description": "The request for Datastore.RunQuery.",
- "id": "RunQueryRequest",
- "properties": {
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- },
- "query": {
- "$ref": "Query",
- "description": "The query to run."
},
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
},
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
}
},
"type": "object"
},
- "CompositeFilter": {
- "description": "A filter that merges multiple other filters using the given operator.",
- "id": "CompositeFilter",
+ "GqlQueryParameter": {
+ "description": "A binding parameter for a GQL query.",
+ "id": "GqlQueryParameter",
"properties": {
- "filters": {
- "description": "The list of filters to combine.\nMust contain at least one filter.",
- "items": {
- "$ref": "Filter"
- },
- "type": "array"
+ "value": {
+ "$ref": "Value",
+ "description": "A value parameter."
},
- "op": {
- "description": "The operator for combining multiple filters.",
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "AND"
- ],
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "The results are required to satisfy each of the combined filters."
- ],
+ "cursor": {
+ "description": "A query cursor. Query cursors are returned in query\nresult batches.",
+ "format": "byte",
"type": "string"
}
},
« no previous file with comments | « discovery/googleapis/dataproc__v1beta2.json ('k') | discovery/googleapis/dns__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698