Index: discovery/googleapis/datastore__v1.json |
diff --git a/discovery/googleapis/datastore__v1.json b/discovery/googleapis/datastore__v1.json |
index 950b9f524e9c63c70b56e5116eaf980273b6d933..5152cf6fc38b0a0aaa3c34e00fcc28889fc5d6f1 100644 |
--- a/discovery/googleapis/datastore__v1.json |
+++ b/discovery/googleapis/datastore__v1.json |
@@ -27,37 +27,6 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "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", |
- "type": "string" |
- }, |
- "prettyPrint": { |
- "default": "true", |
- "description": "Returns response with indentations and line breaks.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
- "location": "query", |
- "type": "string" |
- }, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
- "location": "query", |
- "type": "string" |
- }, |
"callback": { |
"description": "JSONP", |
"location": "query", |
@@ -92,13 +61,13 @@ |
"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.", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "access_token": { |
- "description": "OAuth access token.", |
+ "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" |
}, |
@@ -112,16 +81,47 @@ |
"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", |
+ "type": "string" |
+ }, |
+ "prettyPrint": { |
+ "default": "true", |
+ "description": "Returns response with indentations and line breaks.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"protocol": "rest", |
"resources": { |
"projects": { |
"methods": { |
- "runQuery": { |
- "description": "Queries for entities.", |
+ "allocateIds": { |
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", |
"httpMethod": "POST", |
- "id": "datastore.projects.runQuery", |
+ "id": "datastore.projects.allocateIds", |
"parameterOrder": [ |
"projectId" |
], |
@@ -133,22 +133,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:runQuery", |
+ "path": "v1/projects/{projectId}:allocateIds", |
"request": { |
- "$ref": "RunQueryRequest" |
+ "$ref": "AllocateIdsRequest" |
}, |
"response": { |
- "$ref": "RunQueryResponse" |
+ "$ref": "AllocateIdsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/datastore" |
] |
}, |
- "rollback": { |
- "description": "Rolls back a transaction.", |
+ "commit": { |
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.", |
"httpMethod": "POST", |
- "id": "datastore.projects.rollback", |
+ "id": "datastore.projects.commit", |
"parameterOrder": [ |
"projectId" |
], |
@@ -160,22 +160,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:rollback", |
+ "path": "v1/projects/{projectId}:commit", |
"request": { |
- "$ref": "RollbackRequest" |
+ "$ref": "CommitRequest" |
}, |
"response": { |
- "$ref": "RollbackResponse" |
+ "$ref": "CommitResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/datastore" |
] |
}, |
- "lookup": { |
- "description": "Looks up entities by key.", |
+ "beginTransaction": { |
+ "description": "Begins a new transaction.", |
"httpMethod": "POST", |
- "id": "datastore.projects.lookup", |
+ "id": "datastore.projects.beginTransaction", |
"parameterOrder": [ |
"projectId" |
], |
@@ -187,22 +187,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:lookup", |
+ "path": "v1/projects/{projectId}:beginTransaction", |
"request": { |
- "$ref": "LookupRequest" |
+ "$ref": "BeginTransactionRequest" |
}, |
"response": { |
- "$ref": "LookupResponse" |
+ "$ref": "BeginTransactionResponse" |
}, |
"scopes": [ |
"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.", |
+ "runQuery": { |
+ "description": "Queries for entities.", |
"httpMethod": "POST", |
- "id": "datastore.projects.allocateIds", |
+ "id": "datastore.projects.runQuery", |
"parameterOrder": [ |
"projectId" |
], |
@@ -214,22 +214,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:allocateIds", |
+ "path": "v1/projects/{projectId}:runQuery", |
"request": { |
- "$ref": "AllocateIdsRequest" |
+ "$ref": "RunQueryRequest" |
}, |
"response": { |
- "$ref": "AllocateIdsResponse" |
+ "$ref": "RunQueryResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/datastore" |
] |
}, |
- "commit": { |
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.", |
+ "rollback": { |
+ "description": "Rolls back a transaction.", |
"httpMethod": "POST", |
- "id": "datastore.projects.commit", |
+ "id": "datastore.projects.rollback", |
"parameterOrder": [ |
"projectId" |
], |
@@ -241,22 +241,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:commit", |
+ "path": "v1/projects/{projectId}:rollback", |
"request": { |
- "$ref": "CommitRequest" |
+ "$ref": "RollbackRequest" |
}, |
"response": { |
- "$ref": "CommitResponse" |
+ "$ref": "RollbackResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/datastore" |
] |
}, |
- "beginTransaction": { |
- "description": "Begins a new transaction.", |
+ "lookup": { |
+ "description": "Looks up entities by key.", |
"httpMethod": "POST", |
- "id": "datastore.projects.beginTransaction", |
+ "id": "datastore.projects.lookup", |
"parameterOrder": [ |
"projectId" |
], |
@@ -268,12 +268,12 @@ |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}:beginTransaction", |
+ "path": "v1/projects/{projectId}:lookup", |
"request": { |
- "$ref": "BeginTransactionRequest" |
+ "$ref": "LookupRequest" |
}, |
"response": { |
- "$ref": "BeginTransactionResponse" |
+ "$ref": "LookupResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -405,1073 +405,1073 @@ |
} |
} |
}, |
- "revision": "20170811", |
+ "revision": "20170821", |
"rootUrl": "https://datastore.googleapis.com/", |
"schemas": { |
- "Mutation": { |
- "description": "A mutation to apply to an entity.", |
- "id": "Mutation", |
+ "GoogleLongrunningListOperationsResponse": { |
+ "description": "The response message for Operations.ListOperations.", |
+ "id": "GoogleLongrunningListOperationsResponse", |
"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." |
+ "operations": { |
+ "description": "A list of operations that matches the specified filter in the request.", |
+ "items": { |
+ "$ref": "GoogleLongrunningOperation" |
+ }, |
+ "type": "array" |
}, |
- "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", |
+ "nextPageToken": { |
+ "description": "The standard List next-page token.", |
"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" |
}, |
- "ReadOptions": { |
- "description": "The options shared by read requests.", |
- "id": "ReadOptions", |
+ "BeginTransactionResponse": { |
+ "description": "The response for Datastore.BeginTransaction.", |
+ "id": "BeginTransactionResponse", |
"properties": { |
"transaction": { |
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", |
+ "description": "The transaction identifier (always present).", |
"format": "byte", |
"type": "string" |
- }, |
- "readConsistency": { |
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.", |
- "enum": [ |
- "READ_CONSISTENCY_UNSPECIFIED", |
- "STRONG", |
- "EVENTUAL" |
- ], |
- "enumDescriptions": [ |
- "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" |
- }, |
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { |
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", |
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse", |
+ "LookupResponse": { |
+ "description": "The response for Datastore.Lookup.", |
+ "id": "LookupResponse", |
"properties": { |
- "outputUrl": { |
- "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.", |
- "type": "string" |
+ "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": "Key" |
+ }, |
+ "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.", |
+ "items": { |
+ "$ref": "EntityResult" |
+ }, |
+ "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.", |
+ "items": { |
+ "$ref": "EntityResult" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "MutationResult": { |
- "description": "The result of applying a mutation.", |
- "id": "MutationResult", |
+ "RunQueryResponse": { |
+ "description": "The response for Datastore.RunQuery.", |
+ "id": "RunQueryResponse", |
"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." |
+ "query": { |
+ "$ref": "Query", |
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set." |
}, |
- "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" |
+ "batch": { |
+ "$ref": "QueryResultBatch", |
+ "description": "A batch of query results (always present)." |
} |
}, |
"type": "object" |
}, |
- "GqlQuery": { |
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", |
- "id": "GqlQuery", |
+ "AllocateIdsRequest": { |
+ "description": "The request for Datastore.AllocateIds.", |
+ "id": "AllocateIdsRequest", |
"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.", |
+ "keys": { |
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.", |
"items": { |
- "$ref": "GqlQueryParameter" |
+ "$ref": "Key" |
}, |
"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" |
- }, |
- "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" |
- }, |
- "Filter": { |
- "description": "A holder for any type of filter.", |
- "id": "Filter", |
- "properties": { |
- "compositeFilter": { |
- "$ref": "CompositeFilter", |
- "description": "A composite filter." |
- }, |
- "propertyFilter": { |
- "$ref": "PropertyFilter", |
- "description": "A filter on a property." |
} |
}, |
"type": "object" |
}, |
- "RollbackRequest": { |
- "description": "The request for Datastore.Rollback.", |
- "id": "RollbackRequest", |
+ "CommitRequest": { |
+ "description": "The request for Datastore.Commit.", |
+ "id": "CommitRequest", |
"properties": { |
"transaction": { |
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.", |
+ "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" |
+ }, |
+ "mode": { |
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.", |
+ "enum": [ |
+ "MODE_UNSPECIFIED", |
+ "TRANSACTIONAL", |
+ "NON_TRANSACTIONAL" |
+ ], |
+ "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." |
+ ], |
+ "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" |
}, |
- "RunQueryRequest": { |
- "description": "The request for Datastore.RunQuery.", |
- "id": "RunQueryRequest", |
+ "BeginTransactionRequest": { |
+ "description": "The request for Datastore.BeginTransaction.", |
+ "id": "BeginTransactionRequest", |
"properties": { |
- "gqlQuery": { |
- "$ref": "GqlQuery", |
- "description": "The GQL query to run." |
- }, |
- "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." |
+ "transactionOptions": { |
+ "$ref": "TransactionOptions", |
+ "description": "Options for a new transaction." |
} |
}, |
"type": "object" |
}, |
- "Empty": { |
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
- "id": "Empty", |
- "properties": {}, |
- "type": "object" |
- }, |
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { |
- "description": "Metadata for ExportEntities operations.", |
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", |
+ "PropertyOrder": { |
+ "description": "The desired order for a specific property.", |
+ "id": "PropertyOrder", |
"properties": { |
- "common": { |
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
- "description": "Metadata common to all Datastore Admin operations." |
- }, |
- "progressBytes": { |
- "$ref": "GoogleDatastoreAdminV1beta1Progress", |
- "description": "An estimate of the number of bytes processed." |
- }, |
- "outputUrlPrefix": { |
- "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", |
+ "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" |
}, |
- "entityFilter": { |
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
- "description": "Description of which entities are being exported." |
- }, |
- "progressEntities": { |
- "$ref": "GoogleDatastoreAdminV1beta1Progress", |
- "description": "An estimate of the number of entities processed." |
+ "property": { |
+ "$ref": "PropertyReference", |
+ "description": "The property to order by." |
} |
}, |
"type": "object" |
}, |
- "TransactionOptions": { |
- "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.", |
- "id": "TransactionOptions", |
+ "KindExpression": { |
+ "description": "A representation of a kind.", |
+ "id": "KindExpression", |
"properties": { |
- "readOnly": { |
- "$ref": "ReadOnly", |
- "description": "The transaction should only allow reads." |
- }, |
- "readWrite": { |
- "$ref": "ReadWrite", |
- "description": "The transaction should allow both reads and writes." |
+ "name": { |
+ "description": "The name of the kind.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "CompositeFilter": { |
- "description": "A filter that merges multiple other filters using the given operator.", |
- "id": "CompositeFilter", |
+ "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": { |
- "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" |
+ "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." |
}, |
- "filters": { |
- "description": "The list of filters to combine.\nMust contain at least one filter.", |
+ "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": "Filter" |
+ "$ref": "PathElement" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { |
- "description": "Metadata for ImportEntities operations.", |
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", |
+ "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": { |
- "common": { |
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
- "description": "Metadata common to all Datastore Admin operations." |
+ "latitude": { |
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", |
+ "format": "double", |
+ "type": "number" |
}, |
- "inputUrl": { |
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.", |
+ "longitude": { |
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", |
+ "format": "double", |
+ "type": "number" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PropertyReference": { |
+ "description": "A reference to a property relative to the kind expressions.", |
+ "id": "PropertyReference", |
+ "properties": { |
+ "name": { |
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", |
"type": "string" |
- }, |
- "progressBytes": { |
- "$ref": "GoogleDatastoreAdminV1beta1Progress", |
- "description": "An estimate of the number of bytes processed." |
- }, |
- "entityFilter": { |
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
- "description": "Description of which entities are being imported." |
- }, |
- "progressEntities": { |
- "$ref": "GoogleDatastoreAdminV1beta1Progress", |
- "description": "An estimate of the number of entities processed." |
} |
}, |
"type": "object" |
}, |
- "AllocateIdsResponse": { |
- "description": "The response for Datastore.AllocateIds.", |
- "id": "AllocateIdsResponse", |
+ "GoogleDatastoreAdminV1beta1EntityFilter": { |
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", |
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter", |
"properties": { |
- "keys": { |
- "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.", |
+ "kinds": { |
+ "description": "If empty, then this represents all kinds.", |
"items": { |
- "$ref": "Key" |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "namespaceIds": { |
+ "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", |
+ "items": { |
+ "type": "string" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "Query": { |
- "description": "A query for entities.", |
- "id": "Query", |
+ "GoogleDatastoreAdminV1beta1CommonMetadata": { |
+ "description": "Metadata common to all Datastore Admin operations.", |
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata", |
"properties": { |
- "filter": { |
- "$ref": "Filter", |
- "description": "The filter to apply." |
+ "labels": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.", |
+ "type": "object" |
}, |
- "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" |
- }, |
- "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" |
- }, |
- "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" |
- }, |
- "kind": { |
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.", |
- "items": { |
- "$ref": "KindExpression" |
- }, |
- "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).", |
- "items": { |
- "$ref": "PropertyReference" |
- }, |
- "type": "array" |
- }, |
- "order": { |
- "description": "The order to apply to the query results (if empty, order is unspecified).", |
- "items": { |
- "$ref": "PropertyOrder" |
- }, |
- "type": "array" |
- }, |
- "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "GoogleLongrunningOperation": { |
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
- "id": "GoogleLongrunningOperation", |
- "properties": { |
- "error": { |
- "$ref": "Status", |
- "description": "The error result of the operation in case of failure or cancellation." |
- }, |
- "metadata": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
- "type": "object" |
- }, |
- "done": { |
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.", |
- "type": "boolean" |
- }, |
- "response": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", |
- "type": "object" |
- }, |
- "name": { |
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", |
+ "endTime": { |
+ "description": "The time the operation ended, either successfully or otherwise.", |
+ "format": "google-datetime", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "ReadOnly": { |
- "description": "Options specific to read-only transactions.", |
- "id": "ReadOnly", |
- "properties": {}, |
- "type": "object" |
- }, |
- "PropertyFilter": { |
- "description": "A filter on a specific property.", |
- "id": "PropertyFilter", |
- "properties": { |
- "property": { |
- "$ref": "PropertyReference", |
- "description": "The property to filter by." |
}, |
- "op": { |
- "description": "The operator to filter by.", |
+ "state": { |
+ "description": "The current state of the Operation.", |
"enum": [ |
- "OPERATOR_UNSPECIFIED", |
- "LESS_THAN", |
- "LESS_THAN_OR_EQUAL", |
- "GREATER_THAN", |
- "GREATER_THAN_OR_EQUAL", |
- "EQUAL", |
- "HAS_ANCESTOR" |
+ "STATE_UNSPECIFIED", |
+ "INITIALIZING", |
+ "PROCESSING", |
+ "CANCELLING", |
+ "FINALIZING", |
+ "SUCCESSFUL", |
+ "FAILED", |
+ "CANCELLED" |
], |
"enumDescriptions": [ |
- "Unspecified. This value must not be used.", |
- "Less than.", |
- "Less than or equal.", |
- "Greater than.", |
- "Greater than or equal.", |
- "Equal.", |
- "Has ancestor." |
+ "Unspecified.", |
+ "Request is being prepared for processing.", |
+ "Request is actively being processed.", |
+ "Request is in the process of being cancelled after user called\nlongrunning.Operations.CancelOperation on the operation.", |
+ "Request has been processed and is in its finalization stage.", |
+ "Request has completed successfully.", |
+ "Request has finished being processed, but encountered an error.", |
+ "Request has finished being cancelled after user called\nlongrunning.Operations.CancelOperation." |
], |
"type": "string" |
}, |
- "value": { |
- "$ref": "Value", |
- "description": "The value to compare the property to." |
- } |
- }, |
- "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" |
- }, |
- "Value": { |
- "description": "A message that can hold any of the supported value types and associated\nmetadata.", |
- "id": "Value", |
- "properties": { |
- "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" |
- }, |
- "nullValue": { |
- "description": "A null value.", |
+ "operationType": { |
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.", |
"enum": [ |
- "NULL_VALUE" |
+ "OPERATION_TYPE_UNSPECIFIED", |
+ "EXPORT_ENTITIES", |
+ "IMPORT_ENTITIES", |
+ "BUILD_INDEX", |
+ "CLEAR_INDEX" |
], |
"enumDescriptions": [ |
- "Null value." |
+ "Unspecified.", |
+ "ExportEntities.", |
+ "ImportEntities.", |
+ "Build an index.", |
+ "Clear an index." |
], |
"type": "string" |
}, |
- "booleanValue": { |
- "description": "A boolean value.", |
- "type": "boolean" |
- }, |
- "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." |
- }, |
- "keyValue": { |
- "$ref": "Key", |
- "description": "A key value." |
- }, |
- "integerValue": { |
- "description": "An integer value.", |
- "format": "int64", |
+ "startTime": { |
+ "description": "The time that work began on the operation.", |
+ "format": "google-datetime", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "CommitResponse": { |
- "description": "The response for Datastore.Commit.", |
- "id": "CommitResponse", |
- "properties": { |
- "indexUpdates": { |
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "mutationResults": { |
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.", |
- "items": { |
- "$ref": "MutationResult" |
- }, |
- "type": "array" |
- } |
- }, |
- "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", |
+ "Projection": { |
+ "description": "A representation of a property in a projection.", |
+ "id": "Projection", |
"properties": { |
- "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" |
+ "property": { |
+ "$ref": "PropertyReference", |
+ "description": "The property to project." |
} |
}, |
"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", |
+ "ArrayValue": { |
+ "description": "An array value.", |
+ "id": "ArrayValue", |
"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": { |
+ "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": "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "ReadWrite": { |
- "description": "Options specific to read / write transactions.", |
- "id": "ReadWrite", |
- "properties": { |
- "previousTransaction": { |
- "description": "The transaction identifier of the transaction being retried.", |
- "format": "byte", |
- "type": "string" |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "GoogleDatastoreAdminV1beta1Progress": { |
- "description": "Measures the progress of a particular metric.", |
- "id": "GoogleDatastoreAdminV1beta1Progress", |
+ "Mutation": { |
+ "description": "A mutation to apply to an entity.", |
+ "id": "Mutation", |
"properties": { |
- "workEstimated": { |
- "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", |
- "format": "int64", |
- "type": "string" |
+ "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." |
}, |
- "workCompleted": { |
- "description": "Note that this may be greater than work_estimated.", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "LookupRequest": { |
- "description": "The request for Datastore.Lookup.", |
- "id": "LookupRequest", |
- "properties": { |
- "readOptions": { |
- "$ref": "ReadOptions", |
- "description": "The options for this lookup request." |
}, |
- "keys": { |
- "description": "Keys of entities to look up.", |
- "items": { |
- "$ref": "Key" |
- }, |
- "type": "array" |
+ "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": { |
- "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" |
- }, |
- "endCursor": { |
- "description": "A cursor that points to the position after the last result in the batch.", |
- "format": "byte", |
- "type": "string" |
- }, |
- "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" |
- }, |
- "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`.", |
- "enum": [ |
- "RESULT_TYPE_UNSPECIFIED", |
- "FULL", |
- "PROJECTION", |
- "KEY_ONLY" |
+ "readConsistency": { |
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.", |
+ "enum": [ |
+ "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" |
- }, |
- "entityResults": { |
- "description": "The results for this batch.", |
- "items": { |
- "$ref": "EntityResult" |
- }, |
- "type": "array" |
} |
}, |
"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", |
+ "RollbackResponse": { |
+ "description": "The response for Datastore.Rollback.\n(an empty message).", |
+ "id": "RollbackResponse", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { |
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", |
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse", |
"properties": { |
- "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 `\"\"`.", |
+ "outputUrl": { |
+ "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.", |
"type": "string" |
+ } |
+ }, |
+ "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" |
}, |
- "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" |
+ "key": { |
+ "$ref": "Key", |
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key." |
}, |
- "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.", |
+ "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" |
}, |
- "Status": { |
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
- "id": "Status", |
+ "GqlQuery": { |
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", |
+ "id": "GqlQuery", |
"properties": { |
- "code": { |
- "description": "The status code, which should be an enum value of google.rpc.Code.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "message": { |
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
+ "queryString": { |
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", |
"type": "string" |
}, |
- "details": { |
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
+ "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": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "type": "object" |
+ "$ref": "GqlQueryParameter" |
}, |
"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" |
+ }, |
+ "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" |
}, |
- "GqlQueryParameter": { |
- "description": "A binding parameter for a GQL query.", |
- "id": "GqlQueryParameter", |
+ "Filter": { |
+ "description": "A holder for any type of filter.", |
+ "id": "Filter", |
"properties": { |
- "cursor": { |
- "description": "A query cursor. Query cursors are returned in query\nresult batches.", |
- "format": "byte", |
- "type": "string" |
+ "compositeFilter": { |
+ "$ref": "CompositeFilter", |
+ "description": "A composite filter." |
}, |
- "value": { |
- "$ref": "Value", |
- "description": "A value parameter." |
+ "propertyFilter": { |
+ "$ref": "PropertyFilter", |
+ "description": "A filter on a property." |
} |
}, |
"type": "object" |
}, |
- "GoogleLongrunningListOperationsResponse": { |
- "description": "The response message for Operations.ListOperations.", |
- "id": "GoogleLongrunningListOperationsResponse", |
+ "RunQueryRequest": { |
+ "description": "The request for Datastore.RunQuery.", |
+ "id": "RunQueryRequest", |
"properties": { |
- "operations": { |
- "description": "A list of operations that matches the specified filter in the request.", |
- "items": { |
- "$ref": "GoogleLongrunningOperation" |
- }, |
- "type": "array" |
+ "gqlQuery": { |
+ "$ref": "GqlQuery", |
+ "description": "The GQL query to run." |
}, |
- "nextPageToken": { |
- "description": "The standard List next-page token.", |
- "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." |
+ }, |
+ "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", |
+ "Empty": { |
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
+ "id": "Empty", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "RollbackRequest": { |
+ "description": "The request for Datastore.Rollback.", |
+ "id": "RollbackRequest", |
"properties": { |
"transaction": { |
- "description": "The transaction identifier (always present).", |
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.", |
"format": "byte", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "AllocateIdsRequest": { |
- "description": "The request for Datastore.AllocateIds.", |
- "id": "AllocateIdsRequest", |
+ "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { |
+ "description": "Metadata for ExportEntities operations.", |
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", |
"properties": { |
- "keys": { |
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.", |
+ "common": { |
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
+ "description": "Metadata common to all Datastore Admin operations." |
+ }, |
+ "progressBytes": { |
+ "$ref": "GoogleDatastoreAdminV1beta1Progress", |
+ "description": "An estimate of the number of bytes processed." |
+ }, |
+ "outputUrlPrefix": { |
+ "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", |
+ "type": "string" |
+ }, |
+ "entityFilter": { |
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
+ "description": "Description of which entities are being exported." |
+ }, |
+ "progressEntities": { |
+ "$ref": "GoogleDatastoreAdminV1beta1Progress", |
+ "description": "An estimate of the number of entities processed." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TransactionOptions": { |
+ "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.", |
+ "id": "TransactionOptions", |
+ "properties": { |
+ "readOnly": { |
+ "$ref": "ReadOnly", |
+ "description": "The transaction should only allow reads." |
+ }, |
+ "readWrite": { |
+ "$ref": "ReadWrite", |
+ "description": "The transaction should allow both reads and writes." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "CompositeFilter": { |
+ "description": "A filter that merges multiple other filters using the given operator.", |
+ "id": "CompositeFilter", |
+ "properties": { |
+ "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" |
+ }, |
+ "filters": { |
+ "description": "The list of filters to combine.\nMust contain at least one filter.", |
"items": { |
- "$ref": "Key" |
+ "$ref": "Filter" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "RunQueryResponse": { |
- "description": "The response for Datastore.RunQuery.", |
- "id": "RunQueryResponse", |
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { |
+ "description": "Metadata for ImportEntities operations.", |
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", |
"properties": { |
- "query": { |
- "$ref": "Query", |
- "description": "The parsed form of the `GqlQuery` from the request, if it was set." |
+ "common": { |
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", |
+ "description": "Metadata common to all Datastore Admin operations." |
}, |
- "batch": { |
- "$ref": "QueryResultBatch", |
- "description": "A batch of query results (always present)." |
+ "inputUrl": { |
+ "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.", |
+ "type": "string" |
+ }, |
+ "progressBytes": { |
+ "$ref": "GoogleDatastoreAdminV1beta1Progress", |
+ "description": "An estimate of the number of bytes processed." |
+ }, |
+ "entityFilter": { |
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", |
+ "description": "Description of which entities are being imported." |
+ }, |
+ "progressEntities": { |
+ "$ref": "GoogleDatastoreAdminV1beta1Progress", |
+ "description": "An estimate of the number of entities processed." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "AllocateIdsResponse": { |
+ "description": "The response for Datastore.AllocateIds.", |
+ "id": "AllocateIdsResponse", |
+ "properties": { |
+ "keys": { |
+ "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" |
+ }, |
+ "type": "array" |
} |
}, |
"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" |
+ }, |
+ "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" |
+ }, |
+ "filter": { |
+ "$ref": "Filter", |
+ "description": "The filter to apply." |
+ }, |
+ "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" |
+ }, |
+ "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" |
}, |
- "CommitRequest": { |
- "description": "The request for Datastore.Commit.", |
- "id": "CommitRequest", |
+ "GoogleLongrunningOperation": { |
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
+ "id": "GoogleLongrunningOperation", |
"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", |
+ "error": { |
+ "$ref": "Status", |
+ "description": "The error result of the operation in case of failure or cancellation." |
+ }, |
+ "metadata": { |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
+ "type": "object" |
+ }, |
+ "done": { |
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.", |
+ "type": "boolean" |
+ }, |
+ "response": { |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", |
+ "type": "object" |
+ }, |
+ "name": { |
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", |
"type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ReadOnly": { |
+ "description": "Options specific to read-only transactions.", |
+ "id": "ReadOnly", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "PropertyFilter": { |
+ "description": "A filter on a specific property.", |
+ "id": "PropertyFilter", |
+ "properties": { |
+ "value": { |
+ "$ref": "Value", |
+ "description": "The value to compare the property to." |
}, |
- "mode": { |
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.", |
+ "property": { |
+ "$ref": "PropertyReference", |
+ "description": "The property to filter by." |
+ }, |
+ "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" |
}, |
- "BeginTransactionRequest": { |
- "description": "The request for Datastore.BeginTransaction.", |
- "id": "BeginTransactionRequest", |
+ "EntityResult": { |
+ "description": "The result of fetching an entity from Datastore.", |
+ "id": "EntityResult", |
"properties": { |
- "transactionOptions": { |
- "$ref": "TransactionOptions", |
- "description": "Options for a new transaction." |
+ "entity": { |
+ "$ref": "Entity", |
+ "description": "The resulting entity." |
+ }, |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "PropertyOrder": { |
- "description": "The desired order for a specific property.", |
- "id": "PropertyOrder", |
+ "Value": { |
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.", |
+ "id": "Value", |
"properties": { |
- "direction": { |
- "description": "The direction to order by. Defaults to `ASCENDING`.", |
+ "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" |
+ }, |
+ "nullValue": { |
+ "description": "A null value.", |
"enum": [ |
- "DIRECTION_UNSPECIFIED", |
- "ASCENDING", |
- "DESCENDING" |
+ "NULL_VALUE" |
], |
"enumDescriptions": [ |
- "Unspecified. This value must not be used.", |
- "Ascending.", |
- "Descending." |
+ "Null value." |
], |
"type": "string" |
}, |
- "property": { |
- "$ref": "PropertyReference", |
- "description": "The property to order by." |
+ "booleanValue": { |
+ "description": "A boolean value.", |
+ "type": "boolean" |
+ }, |
+ "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." |
+ }, |
+ "keyValue": { |
+ "$ref": "Key", |
+ "description": "A key value." |
+ }, |
+ "integerValue": { |
+ "description": "An integer value.", |
+ "format": "int64", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "KindExpression": { |
- "description": "A representation of a kind.", |
- "id": "KindExpression", |
+ "CommitResponse": { |
+ "description": "The response for Datastore.Commit.", |
+ "id": "CommitResponse", |
"properties": { |
- "name": { |
- "description": "The name of the kind.", |
- "type": "string" |
+ "mutationResults": { |
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.", |
+ "items": { |
+ "$ref": "MutationResult" |
+ }, |
+ "type": "array" |
+ }, |
+ "indexUpdates": { |
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"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", |
+ "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": { |
- "latitude": { |
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", |
- "format": "double", |
- "type": "number" |
+ "namespaceId": { |
+ "description": "If not empty, the ID of the namespace to which the entities belong.", |
+ "type": "string" |
}, |
- "longitude": { |
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", |
- "format": "double", |
- "type": "number" |
+ "projectId": { |
+ "description": "The ID of the project to which the entities belong.", |
+ "type": "string" |
} |
}, |
"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", |
+ "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": { |
- "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" |
+ "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." |
}, |
- "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." |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "PropertyReference": { |
- "description": "A reference to a property relative to the kind expressions.", |
- "id": "PropertyReference", |
+ "ReadWrite": { |
+ "description": "Options specific to read / write transactions.", |
+ "id": "ReadWrite", |
"properties": { |
- "name": { |
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", |
+ "previousTransaction": { |
+ "description": "The transaction identifier of the transaction being retried.", |
+ "format": "byte", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "GoogleDatastoreAdminV1beta1EntityFilter": { |
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", |
- "id": "GoogleDatastoreAdminV1beta1EntityFilter", |
+ "LookupRequest": { |
+ "description": "The request for Datastore.Lookup.", |
+ "id": "LookupRequest", |
"properties": { |
- "kinds": { |
- "description": "If empty, then this represents all kinds.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
+ "readOptions": { |
+ "$ref": "ReadOptions", |
+ "description": "The options for this lookup request." |
}, |
- "namespaceIds": { |
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", |
+ "keys": { |
+ "description": "Keys of entities to look up.", |
"items": { |
- "type": "string" |
+ "$ref": "Key" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "GoogleDatastoreAdminV1beta1CommonMetadata": { |
- "description": "Metadata common to all Datastore Admin operations.", |
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata", |
+ "QueryResultBatch": { |
+ "description": "A batch of results produced by a query.", |
+ "id": "QueryResultBatch", |
"properties": { |
- "labels": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.", |
- "type": "object" |
- }, |
- "endTime": { |
- "description": "The time the operation ended, either successfully or otherwise.", |
- "format": "google-datetime", |
+ "endCursor": { |
+ "description": "A cursor that points to the position after the last result in the batch.", |
+ "format": "byte", |
"type": "string" |
}, |
- "state": { |
- "description": "The current state of the Operation.", |
+ "moreResults": { |
+ "description": "The state of the query after the current batch.", |
"enum": [ |
- "STATE_UNSPECIFIED", |
- "INITIALIZING", |
- "PROCESSING", |
- "CANCELLING", |
- "FINALIZING", |
- "SUCCESSFUL", |
- "FAILED", |
- "CANCELLED" |
+ "MORE_RESULTS_TYPE_UNSPECIFIED", |
+ "NOT_FINISHED", |
+ "MORE_RESULTS_AFTER_LIMIT", |
+ "MORE_RESULTS_AFTER_CURSOR", |
+ "NO_MORE_RESULTS" |
], |
"enumDescriptions": [ |
- "Unspecified.", |
- "Request is being prepared for processing.", |
- "Request is actively being processed.", |
- "Request is in the process of being cancelled after user called\nlongrunning.Operations.CancelOperation on the operation.", |
- "Request has been processed and is in its finalization stage.", |
- "Request has completed successfully.", |
- "Request has finished being processed, but encountered an error.", |
- "Request has finished being cancelled after user called\nlongrunning.Operations.CancelOperation." |
+ "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" |
}, |
- "operationType": { |
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.", |
+ "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" |
+ }, |
+ "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" |
+ }, |
+ "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": [ |
- "OPERATION_TYPE_UNSPECIFIED", |
- "EXPORT_ENTITIES", |
- "IMPORT_ENTITIES", |
- "BUILD_INDEX", |
- "CLEAR_INDEX" |
+ "RESULT_TYPE_UNSPECIFIED", |
+ "FULL", |
+ "PROJECTION", |
+ "KEY_ONLY" |
], |
"enumDescriptions": [ |
- "Unspecified.", |
- "ExportEntities.", |
- "ImportEntities.", |
- "Build an index.", |
- "Clear an index." |
+ "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" |
}, |
- "startTime": { |
- "description": "The time that work began on the operation.", |
- "format": "google-datetime", |
+ "entityResults": { |
+ "description": "The results for this batch.", |
+ "items": { |
+ "$ref": "EntityResult" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "GoogleDatastoreAdminV1beta1Progress": { |
+ "description": "Measures the progress of a particular metric.", |
+ "id": "GoogleDatastoreAdminV1beta1Progress", |
+ "properties": { |
+ "workEstimated": { |
+ "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "workCompleted": { |
+ "description": "Note that this may be greater than work_estimated.", |
+ "format": "int64", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "Projection": { |
- "description": "A representation of a property in a projection.", |
- "id": "Projection", |
+ "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": { |
- "property": { |
- "$ref": "PropertyReference", |
- "description": "The property to project." |
+ "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" |
+ }, |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "ArrayValue": { |
- "description": "An array value.", |
- "id": "ArrayValue", |
+ "GqlQueryParameter": { |
+ "description": "A binding parameter for a GQL query.", |
+ "id": "GqlQueryParameter", |
"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.", |
+ "cursor": { |
+ "description": "A query cursor. Query cursors are returned in query\nresult batches.", |
+ "format": "byte", |
+ "type": "string" |
+ }, |
+ "value": { |
+ "$ref": "Value", |
+ "description": "A value parameter." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Status": { |
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
+ "id": "Status", |
+ "properties": { |
+ "details": { |
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
"items": { |
- "$ref": "Value" |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "type": "object" |
}, |
"type": "array" |
+ }, |
+ "code": { |
+ "description": "The status code, which should be an enum value of google.rpc.Code.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "message": { |
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
+ "type": "string" |
} |
}, |
"type": "object" |