blob: 21d343f70e7e13a16463307c8b3425cf63c767a3 [file]
{
"batchPath": "batch",
"resources": {
"projects": {
"methods": {
"reserveIds": {
"id": "datastore.projects.reserveIds",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.",
"parameterOrder": [
"projectId"
],
"request": {
"$ref": "ReserveIdsRequest"
},
"parameters": {
"projectId": {
"location": "path",
"description": "Required. The ID of the project against which to make the request.",
"type": "string",
"required": true
}
},
"path": "v1beta3/projects/{projectId}:reserveIds",
"response": {
"$ref": "ReserveIdsResponse"
},
"flatPath": "v1beta3/projects/{projectId}:reserveIds",
"httpMethod": "POST"
},
"rollback": {
"request": {
"$ref": "RollbackRequest"
},
"path": "v1beta3/projects/{projectId}:rollback",
"parameterOrder": [
"projectId"
],
"id": "datastore.projects.rollback",
"response": {
"$ref": "RollbackResponse"
},
"flatPath": "v1beta3/projects/{projectId}:rollback",
"parameters": {
"projectId": {
"type": "string",
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true
}
},
"httpMethod": "POST",
"description": "Rolls back a transaction.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"runQuery": {
"flatPath": "v1beta3/projects/{projectId}:runQuery",
"id": "datastore.projects.runQuery",
"description": "Queries for entities.",
"httpMethod": "POST",
"path": "v1beta3/projects/{projectId}:runQuery",
"request": {
"$ref": "RunQueryRequest"
},
"response": {
"$ref": "RunQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"required": true,
"type": "string",
"location": "path"
}
}
},
"allocateIds": {
"description": "Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"type": "string",
"description": "Required. The ID of the project against which to make the request.",
"required": true,
"location": "path"
}
},
"id": "datastore.projects.allocateIds",
"flatPath": "v1beta3/projects/{projectId}:allocateIds",
"path": "v1beta3/projects/{projectId}:allocateIds",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"request": {
"$ref": "AllocateIdsRequest"
},
"response": {
"$ref": "AllocateIdsResponse"
}
},
"lookup": {
"path": "v1beta3/projects/{projectId}:lookup",
"response": {
"$ref": "LookupResponse"
},
"flatPath": "v1beta3/projects/{projectId}:lookup",
"parameters": {
"projectId": {
"type": "string",
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true
}
},
"request": {
"$ref": "LookupRequest"
},
"id": "datastore.projects.lookup",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"httpMethod": "POST",
"parameterOrder": [
"projectId"
],
"description": "Looks up entities by key."
},
"beginTransaction": {
"response": {
"$ref": "BeginTransactionResponse"
},
"request": {
"$ref": "BeginTransactionRequest"
},
"id": "datastore.projects.beginTransaction",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"httpMethod": "POST",
"description": "Begins a new transaction.",
"flatPath": "v1beta3/projects/{projectId}:beginTransaction",
"parameters": {
"projectId": {
"location": "path",
"type": "string",
"required": true,
"description": "Required. The ID of the project against which to make the request."
}
},
"parameterOrder": [
"projectId"
],
"path": "v1beta3/projects/{projectId}:beginTransaction"
},
"commit": {
"request": {
"$ref": "CommitRequest"
},
"path": "v1beta3/projects/{projectId}:commit",
"httpMethod": "POST",
"flatPath": "v1beta3/projects/{projectId}:commit",
"parameterOrder": [
"projectId"
],
"id": "datastore.projects.commit",
"parameters": {
"projectId": {
"required": true,
"location": "path",
"description": "Required. The ID of the project against which to make the request.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"description": "Commits a transaction, optionally creating, deleting or modifying some entities.",
"response": {
"$ref": "CommitResponse"
}
}
}
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. ",
"servicePath": "",
"baseUrl": "https://datastore.googleapis.com/",
"name": "datastore",
"revision": "20201017",
"version": "v1beta3",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"parameters": {
"key": {
"location": "query",
"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.",
"type": "string"
},
"access_token": {
"location": "query",
"type": "string",
"description": "OAuth access token."
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"alt": {
"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",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"description": "Data format for response."
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query",
"type": "boolean"
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"type": "string",
"location": "query",
"description": "V1 error format."
},
"quotaUser": {
"location": "query",
"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.",
"type": "string"
}
},
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/datastore/",
"basePath": "",
"id": "datastore:v1beta3",
"kind": "discovery#restDescription",
"title": "Cloud Datastore API",
"protocol": "rest",
"version_module": true,
"ownerName": "Google",
"schemas": {
"GoogleDatastoreAdminV1ImportEntitiesMetadata": {
"id": "GoogleDatastoreAdminV1ImportEntitiesMetadata",
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1Progress"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1EntityFilter",
"description": "Description of which entities are being imported."
},
"inputUrl": {
"description": "The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field.",
"type": "string"
},
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1CommonMetadata"
},
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1Progress",
"description": "An estimate of the number of entities processed."
}
}
},
"PropertyReference": {
"id": "PropertyReference",
"properties": {
"name": {
"type": "string",
"description": "The name of the property. If name includes \".\"s, it may be interpreted as a property name path."
}
},
"description": "A reference to a property relative to the kind expressions.",
"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 its key path completed with a newly allocated ID.",
"type": "array",
"items": {
"$ref": "Key"
}
}
},
"type": "object"
},
"TransactionOptions": {
"type": "object",
"properties": {
"readWrite": {
"$ref": "ReadWrite",
"description": "The transaction should allow both reads and writes."
},
"readOnly": {
"$ref": "ReadOnly",
"description": "The transaction should only allow reads."
}
},
"id": "TransactionOptions",
"description": "Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests."
},
"BeginTransactionRequest": {
"id": "BeginTransactionRequest",
"type": "object",
"properties": {
"transactionOptions": {
"description": "Options for a new transaction.",
"$ref": "TransactionOptions"
}
},
"description": "The request for Datastore.BeginTransaction."
},
"GqlQueryParameter": {
"id": "GqlQueryParameter",
"type": "object",
"properties": {
"value": {
"description": "A value parameter.",
"$ref": "Value"
},
"cursor": {
"description": "A query cursor. Query cursors are returned in query result batches.",
"format": "byte",
"type": "string"
}
},
"description": "A binding parameter for a GQL query."
},
"CompositeFilter": {
"id": "CompositeFilter",
"description": "A filter that merges multiple other filters using the given operator.",
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"$ref": "Filter"
},
"description": "The list of filters to combine. Must contain at least one filter."
},
"op": {
"type": "string",
"description": "The operator for combining multiple filters.",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
],
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
]
}
}
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
"type": "object",
"id": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations.",
"properties": {
"state": {
"enum": [
"STATE_UNSPECIFIED",
"INITIALIZING",
"PROCESSING",
"CANCELLING",
"FINALIZING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
"Request is actively being processed.",
"Request is in the process of being cancelled after user called google.longrunning.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 google.longrunning.Operations.CancelOperation."
],
"type": "string",
"description": "The current state of the Operation."
},
"endTime": {
"type": "string",
"format": "google-datetime",
"description": "The time the operation ended, either successfully or otherwise."
},
"startTime": {
"description": "The time that work began on the operation.",
"type": "string",
"format": "google-datetime"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "The client-assigned labels which were provided when the operation was created. May also include additional labels."
},
"operationType": {
"type": "string",
"description": "The type of the operation. Can be used as a filter in ListOperationsRequest.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES"
],
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities."
]
}
}
},
"PathElement": {
"id": "PathElement",
"description": "A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.",
"properties": {
"name": {
"type": "string",
"description": "The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`."
},
"kind": {
"type": "string",
"description": "The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`."
},
"id": {
"description": "The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleDatastoreAdminV1beta1Progress": {
"id": "GoogleDatastoreAdminV1beta1Progress",
"properties": {
"workEstimated": {
"format": "int64",
"description": "An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.",
"type": "string"
},
"workCompleted": {
"type": "string",
"format": "int64",
"description": "The amount of work that has been completed. Note that this may be greater than work_estimated."
}
},
"type": "object",
"description": "Measures the progress of a particular metric."
},
"GoogleDatastoreAdminV1Progress": {
"type": "object",
"properties": {
"workCompleted": {
"format": "int64",
"type": "string",
"description": "The amount of work that has been completed. Note that this may be greater than work_estimated."
},
"workEstimated": {
"format": "int64",
"type": "string",
"description": "An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable."
}
},
"description": "Measures the progress of a particular metric.",
"id": "GoogleDatastoreAdminV1Progress"
},
"LookupResponse": {
"id": "LookupResponse",
"description": "The response for Datastore.Lookup.",
"type": "object",
"properties": {
"missing": {
"description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.",
"type": "array",
"items": {
"$ref": "EntityResult"
}
},
"deferred": {
"type": "array",
"description": "A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.",
"items": {
"$ref": "Key"
}
},
"found": {
"type": "array",
"description": "Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.",
"items": {
"$ref": "EntityResult"
}
}
}
},
"MutationResult": {
"type": "object",
"properties": {
"version": {
"format": "int64",
"type": "string",
"description": "The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity."
},
"key": {
"$ref": "Key",
"description": "The automatically allocated key. Set only when the mutation allocated a key."
},
"conflictDetected": {
"type": "boolean",
"description": "Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation."
}
},
"id": "MutationResult",
"description": "The result of applying a mutation."
},
"RunQueryRequest": {
"description": "The request for Datastore.RunQuery.",
"properties": {
"query": {
"$ref": "Query",
"description": "The query to run."
},
"gqlQuery": {
"description": "The GQL query to run.",
"$ref": "GqlQuery"
},
"readOptions": {
"$ref": "ReadOptions",
"description": "The options for this query."
},
"partitionId": {
"description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.",
"$ref": "PartitionId"
}
},
"id": "RunQueryRequest",
"type": "object"
},
"Projection": {
"type": "object",
"description": "A representation of a property in a projection.",
"properties": {
"property": {
"description": "The property to project.",
"$ref": "PropertyReference"
}
},
"id": "Projection"
},
"RunQueryResponse": {
"properties": {
"query": {
"$ref": "Query",
"description": "The parsed form of the `GqlQuery` from the request, if it was set."
},
"batch": {
"$ref": "QueryResultBatch",
"description": "A batch of query results (always present)."
}
},
"id": "RunQueryResponse",
"type": "object",
"description": "The response for Datastore.RunQuery."
},
"GoogleDatastoreAdminV1ExportEntitiesResponse": {
"id": "GoogleDatastoreAdminV1ExportEntitiesResponse",
"properties": {
"outputUrl": {
"type": "string",
"description": "Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully."
}
},
"description": "The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.",
"type": "object"
},
"RollbackResponse": {
"description": "The response for Datastore.Rollback. (an empty message).",
"properties": {},
"type": "object",
"id": "RollbackResponse"
},
"LatLng": {
"type": "object",
"id": "LatLng",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"type": "number",
"format": "double"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"type": "number",
"format": "double"
}
},
"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges."
},
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
"properties": {
"outputUrl": {
"description": "Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully.",
"type": "string"
}
},
"description": "The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
"type": "object",
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
},
"GoogleDatastoreAdminV1beta1EntityFilter": {
"id": "GoogleDatastoreAdminV1beta1EntityFilter",
"type": "object",
"description": "Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']",
"properties": {
"kinds": {
"items": {
"type": "string"
},
"type": "array",
"description": "If empty, then this represents all kinds."
},
"namespaceIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique."
}
}
},
"CommitRequest": {
"description": "The request for Datastore.Commit.",
"properties": {
"mode": {
"description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Transactional: The mutations are either all applied, or none are applied. Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Non-transactional: The mutations may not apply as all or none."
],
"enum": [
"MODE_UNSPECIFIED",
"TRANSACTIONAL",
"NON_TRANSACTIONAL"
],
"type": "string"
},
"mutations": {
"description": "The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.",
"items": {
"$ref": "Mutation"
},
"type": "array"
},
"transaction": {
"description": "The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.",
"format": "byte",
"type": "string"
}
},
"id": "CommitRequest",
"type": "object"
},
"Entity": {
"id": "Entity",
"description": "A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message.",
"type": "object",
"properties": {
"properties": {
"type": "object",
"description": "The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `\"\"`.",
"additionalProperties": {
"$ref": "Value"
}
},
"key": {
"description": "The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.",
"$ref": "Key"
}
}
},
"QueryResultBatch": {
"type": "object",
"properties": {
"entityResults": {
"description": "The results for this batch.",
"items": {
"$ref": "EntityResult"
},
"type": "array"
},
"entityResultType": {
"enum": [
"RESULT_TYPE_UNSPECIFIED",
"FULL",
"PROJECTION",
"KEY_ONLY"
],
"type": "string",
"description": "The result type for every entity in `entity_results`.",
"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."
]
},
"moreResults": {
"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 cursor.",
"The query is finished, and there are no more results."
],
"type": "string",
"description": "The state of the query after the current batch."
},
"snapshotVersion": {
"type": "string",
"format": "int64",
"description": "The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries."
},
"endCursor": {
"format": "byte",
"description": "A cursor that points to the position after the last result in the batch.",
"type": "string"
},
"skippedCursor": {
"format": "byte",
"description": "A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.",
"type": "string"
},
"skippedResults": {
"description": "The number of results skipped, typically because of an offset.",
"type": "integer",
"format": "int32"
}
},
"description": "A batch of results produced by a query.",
"id": "QueryResultBatch"
},
"CommitResponse": {
"description": "The response for Datastore.Commit.",
"properties": {
"indexUpdates": {
"type": "integer",
"format": "int32",
"description": "The number of index entries updated during the commit, or zero if none were updated."
},
"mutationResults": {
"items": {
"$ref": "MutationResult"
},
"description": "The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.",
"type": "array"
}
},
"id": "CommitResponse",
"type": "object"
},
"GoogleDatastoreAdminV1ExportEntitiesMetadata": {
"id": "GoogleDatastoreAdminV1ExportEntitiesMetadata",
"properties": {
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1Progress"
},
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1CommonMetadata"
},
"entityFilter": {
"description": "Description of which entities are being exported.",
"$ref": "GoogleDatastoreAdminV1EntityFilter"
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1Progress"
},
"outputUrlPrefix": {
"type": "string",
"description": "Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url."
}
},
"description": "Metadata for ExportEntities operations.",
"type": "object"
},
"PropertyFilter": {
"properties": {
"value": {
"$ref": "Value",
"description": "The value to compare the property to."
},
"property": {
"description": "The property to filter by.",
"$ref": "PropertyReference"
},
"op": {
"type": "string",
"description": "The operator to filter by.",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Less than.",
"Less than or equal.",
"Greater than.",
"Greater than or equal.",
"Equal.",
"Has ancestor."
],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
"LESS_THAN_OR_EQUAL",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL",
"EQUAL",
"HAS_ANCESTOR"
]
}
},
"type": "object",
"id": "PropertyFilter",
"description": "A filter on a specific property."
},
"ArrayValue": {
"properties": {
"values": {
"type": "array",
"description": "Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.",
"items": {
"$ref": "Value"
}
}
},
"description": "An array value.",
"type": "object",
"id": "ArrayValue"
},
"ReadWrite": {
"description": "Options specific to read / write transactions.",
"type": "object",
"properties": {
"previousTransaction": {
"type": "string",
"format": "byte",
"description": "The transaction identifier of the transaction being retried."
}
},
"id": "ReadWrite"
},
"EntityResult": {
"properties": {
"cursor": {
"description": "A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.",
"format": "byte",
"type": "string"
},
"entity": {
"description": "The resulting entity.",
"$ref": "Entity"
},
"version": {
"type": "string",
"format": "int64",
"description": "The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads."
}
},
"id": "EntityResult",
"description": "The result of fetching an entity from Datastore.",
"type": "object"
},
"Filter": {
"id": "Filter",
"type": "object",
"description": "A holder for any type of filter.",
"properties": {
"compositeFilter": {
"$ref": "CompositeFilter",
"description": "A composite filter."
},
"propertyFilter": {
"$ref": "PropertyFilter",
"description": "A filter on a property."
}
}
},
"GoogleDatastoreAdminV1CommonMetadata": {
"description": "Metadata common to all Datastore Admin operations.",
"id": "GoogleDatastoreAdminV1CommonMetadata",
"type": "object",
"properties": {
"startTime": {
"format": "google-datetime",
"description": "The time that work began on the operation.",
"type": "string"
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
"type": "string",
"format": "google-datetime"
},
"operationType": {
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities.",
"CreateIndex.",
"DeleteIndex."
],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES",
"CREATE_INDEX",
"DELETE_INDEX"
],
"type": "string",
"description": "The type of the operation. Can be used as a filter in ListOperationsRequest."
},
"state": {
"type": "string",
"description": "The current state of the Operation.",
"enum": [
"STATE_UNSPECIFIED",
"INITIALIZING",
"PROCESSING",
"CANCELLING",
"FINALIZING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
"Request is actively being processed.",
"Request is in the process of being cancelled after user called google.longrunning.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 google.longrunning.Operations.CancelOperation."
]
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The client-assigned labels which were provided when the operation was created. May also include additional labels."
}
}
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
"inputUrl": {
"type": "string",
"description": "The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field."
},
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of entities processed."
},
"progressBytes": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
"description": "An estimate of the number of bytes processed."
},
"entityFilter": {
"description": "Description of which entities are being imported.",
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
}
}
},
"RollbackRequest": {
"id": "RollbackRequest",
"description": "The request for Datastore.Rollback.",
"type": "object",
"properties": {
"transaction": {
"type": "string",
"format": "byte",
"description": "Required. The transaction identifier, returned by a call to Datastore.BeginTransaction."
}
}
},
"Value": {
"type": "object",
"id": "Value",
"properties": {
"geoPointValue": {
"description": "A geo point value representing a point on the surface of Earth.",
"$ref": "LatLng"
},
"excludeFromIndexes": {
"type": "boolean",
"description": "If the value should be excluded from all indexes including those defined explicitly."
},
"arrayValue": {
"description": "An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.",
"$ref": "ArrayValue"
},
"blobValue": {
"format": "byte",
"type": "string",
"description": "A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded."
},
"meaning": {
"description": "The `meaning` field should only be populated for backwards compatibility.",
"type": "integer",
"format": "int32"
},
"timestampValue": {
"description": "A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.",
"type": "string",
"format": "google-datetime"
},
"doubleValue": {
"format": "double",
"type": "number",
"description": "A double value."
},
"stringValue": {
"type": "string",
"description": "A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes."
},
"keyValue": {
"description": "A key value.",
"$ref": "Key"
},
"integerValue": {
"description": "An integer value.",
"format": "int64",
"type": "string"
},
"entityValue": {
"$ref": "Entity",
"description": "An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key."
},
"nullValue": {
"enum": [
"NULL_VALUE"
],
"enumDescriptions": [
"Null value."
],
"description": "A null value.",
"type": "string"
},
"booleanValue": {
"description": "A boolean value.",
"type": "boolean"
}
},
"description": "A message that can hold any of the supported value types and associated metadata."
},
"BeginTransactionResponse": {
"properties": {
"transaction": {
"type": "string",
"format": "byte",
"description": "The transaction identifier (always present)."
}
},
"description": "The response for Datastore.BeginTransaction.",
"type": "object",
"id": "BeginTransactionResponse"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"properties": {
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"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 value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
},
"entityFilter": {
"description": "Description of which entities are being exported.",
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
}
},
"description": "Metadata for ExportEntities operations.",
"type": "object",
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
"Mutation": {
"description": "A mutation to apply to an entity.",
"id": "Mutation",
"type": "object",
"properties": {
"insert": {
"description": "The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.",
"$ref": "Entity"
},
"delete": {
"$ref": "Key",
"description": "The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only."
},
"baseVersion": {
"description": "The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.",
"format": "int64",
"type": "string"
},
"update": {
"$ref": "Entity",
"description": "The entity to update. The entity must already exist. Must have a complete key path."
},
"upsert": {
"$ref": "Entity",
"description": "The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete."
}
}
},
"Query": {
"type": "object",
"description": "A query for entities.",
"properties": {
"startCursor": {
"type": "string",
"format": "byte",
"description": "A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets)."
},
"endCursor": {
"type": "string",
"description": "An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte"
},
"order": {
"description": "The order to apply to the query results (if empty, order is unspecified).",
"items": {
"$ref": "PropertyOrder"
},
"type": "array"
},
"distinctOn": {
"type": "array",
"items": {
"$ref": "PropertyReference"
},
"description": "The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned)."
},
"offset": {
"format": "int32",
"description": "The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be \u003e= 0 if specified.",
"type": "integer"
},
"filter": {
"description": "The filter to apply.",
"$ref": "Filter"
},
"kind": {
"type": "array",
"description": "The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.",
"items": {
"$ref": "KindExpression"
}
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be \u003e= 0 if specified."
},
"projection": {
"type": "array",
"description": "The projection to return. Defaults to returning all properties.",
"items": {
"$ref": "Projection"
}
}
},
"id": "Query"
},
"PropertyOrder": {
"type": "object",
"description": "The desired order for a specific property.",
"id": "PropertyOrder",
"properties": {
"direction": {
"type": "string",
"enum": [
"DIRECTION_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Ascending.",
"Descending."
],
"description": "The direction to order by. Defaults to `ASCENDING`."
},
"property": {
"$ref": "PropertyReference",
"description": "The property to order by."
}
}
},
"ReserveIdsResponse": {
"properties": {},
"type": "object",
"id": "ReserveIdsResponse",
"description": "The response for Datastore.ReserveIds."
},
"AllocateIdsRequest": {
"description": "The request for Datastore.AllocateIds.",
"properties": {
"keys": {
"type": "array",
"description": "Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.",
"items": {
"$ref": "Key"
}
}
},
"id": "AllocateIdsRequest",
"type": "object"
},
"GoogleDatastoreAdminV1EntityFilter": {
"id": "GoogleDatastoreAdminV1EntityFilter",
"properties": {
"namespaceIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique."
},
"kinds": {
"items": {
"type": "string"
},
"description": "If empty, then this represents all kinds.",
"type": "array"
}
},
"description": "Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']",
"type": "object"
},
"ReadOnly": {
"id": "ReadOnly",
"description": "Options specific to read-only transactions.",
"properties": {},
"type": "object"
},
"ReadOptions": {
"id": "ReadOptions",
"properties": {
"transaction": {
"type": "string",
"format": "byte",
"description": "The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction."
},
"readConsistency": {
"description": "The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Strong consistency.",
"Eventual consistency."
],
"type": "string",
"enum": [
"READ_CONSISTENCY_UNSPECIFIED",
"STRONG",
"EVENTUAL"
]
}
},
"type": "object",
"description": "The options shared by read requests."
},
"Key": {
"description": "A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.",
"id": "Key",
"properties": {
"partitionId": {
"$ref": "PartitionId",
"description": "Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition."
},
"path": {
"description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.",
"items": {
"$ref": "PathElement"
},
"type": "array"
}
},
"type": "object"
},
"LookupRequest": {
"description": "The request for Datastore.Lookup.",
"type": "object",
"properties": {
"keys": {
"description": "Required. Keys of entities to look up.",
"type": "array",
"items": {
"$ref": "Key"
}
},
"readOptions": {
"description": "The options for this lookup request.",
"$ref": "ReadOptions"
}
},
"id": "LookupRequest"
},
"ReserveIdsRequest": {
"type": "object",
"description": "The request for Datastore.ReserveIds.",
"properties": {
"keys": {
"items": {
"$ref": "Key"
},
"description": "Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.",
"type": "array"
},
"databaseId": {
"description": "If not empty, the ID of the database against which to make the request.",
"type": "string"
}
},
"id": "ReserveIdsRequest"
},
"GqlQuery": {
"properties": {
"queryString": {
"description": "A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"type": "string"
},
"namedBindings": {
"type": "object",
"additionalProperties": {
"$ref": "GqlQueryParameter"
},
"description": "For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `\"\"`."
},
"allowLiterals": {
"type": "boolean",
"description": "When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is."
},
"positionalBindings": {
"type": "array",
"description": "Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.",
"items": {
"$ref": "GqlQueryParameter"
}
}
},
"description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"id": "GqlQuery",
"type": "object"
},
"PartitionId": {
"id": "PartitionId",
"type": "object",
"description": "A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `\"\"`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.",
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project to which the entities belong."
},
"namespaceId": {
"type": "string",
"description": "If not empty, the ID of the namespace to which the entities belong."
}
}
},
"KindExpression": {
"description": "A representation of a kind.",
"id": "KindExpression",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
"type": "object"
},
"GoogleDatastoreAdminV1IndexOperationMetadata": {
"type": "object",
"id": "GoogleDatastoreAdminV1IndexOperationMetadata",
"description": "Metadata for Index operations.",
"properties": {
"progressEntities": {
"$ref": "GoogleDatastoreAdminV1Progress",
"description": "An estimate of the number of entities processed."
},
"indexId": {
"type": "string",
"description": "The index resource ID that this operation is acting on."
},
"common": {
"description": "Metadata common to all Datastore Admin operations.",
"$ref": "GoogleDatastoreAdminV1CommonMetadata"
}
}
}
},
"mtlsRootUrl": "https://datastore.mtls.googleapis.com/",
"rootUrl": "https://datastore.googleapis.com/",
"ownerDomain": "google.com"
}