2026-09-02
▼ ▲ datastore.projects.indexes.delete
HTTP Method : DELETE
Parameter Order :
Parameters :
indexId
Location : path
Type : string
Required : Yes
Description : The resource ID of the index to delete.
projectId
Type : string
Location : path
Description : Project ID against which to make the request.
Required : Yes
Path : v1/projects/{projectId}/indexes/{indexId}
Description : Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.
Flat Path : v1/projects/{projectId}/indexes/{indexId}
Scopes :
▼ ▲ datastore.projects.indexes.get
Description : Gets an index.
HTTP Method : GET
Parameters :
projectId
Type : string
Location : path
Required : Yes
Description : Project ID against which to make the request.
indexId
Type : string
Location : path
Description : The resource ID of the index to get.
Required : Yes
Flat Path : v1/projects/{projectId}/indexes/{indexId}
Scopes :
Parameter Order :
Path : v1/projects/{projectId}/indexes/{indexId}
▼ ▲ datastore.projects.indexes.list
Flat Path : v1/projects/{projectId}/indexes
Parameters :
pageToken
Location : query
Description : The next_page_token value returned from a previous List request, if any.
Type : string
projectId
Type : string
Description : Project ID against which to make the request.
Required : Yes
Location : path
filter
Location : query
Type : string
pageSize
Description : The maximum number of items to return. If zero, then all results will be returned.
Format : int32
Location : query
Type : integer
Description : Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.
HTTP Method : GET
Path : v1/projects/{projectId}/indexes
Scopes :
Parameter Order : projectId
▼ ▲ datastore.projects.indexes.create
Parameters :
projectId
Location : path
Description : Project ID against which to make the request.
Type : string
Required : Yes
HTTP Method : POST
Path : v1/projects/{projectId}/indexes
Scopes :
Parameter Order : projectId
Flat Path : v1/projects/{projectId}/indexes
Description : Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created.
▼ ▲ datastore.projects.operations.list
Flat Path : v1/projects/{projectsId}/operations
Parameters :
name
Location : path
Pattern : ^projects/[^/]+$
Required : Yes
Type : string
Description : The name of the operation's parent resource.
pageToken
Description : The standard list page token.
Type : string
Location : query
returnPartialSuccess
Location : query
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Type : integer
Format : int32
Location : query
Description : The standard list page size.
HTTP Method : GET
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameter Order : name
Scopes :
▼ ▲ datastore.projects.operations.get
Parameter Order : name
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
Type : string
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/operations/[^/]+$
Scopes :
Path : v1/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/projects/{projectsId}/operations/{operationsId}
▼ ▲ datastore.projects.operations.delete
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Required : Yes
Location : path
HTTP Method : DELETE
Scopes :
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/operations/{operationsId}
▼ ▲ datastore.projects.operations.cancel
Path : v1/{+name}:cancel
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be cancelled.
Scopes :
Flat Path : v1/projects/{projectsId}/operations/{operationsId}:cancel
Parameter Order : name
HTTP Method : POST
▼ ▲ datastore.projects.reserveIds
Description : Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.
Scopes :
Path : v1/projects/{projectId}:reserveIds
Parameters :
projectId
Type : string
Required : Yes
Location : path
Description : Required. The ID of the project against which to make the request.
Flat Path : v1/projects/{projectId}:reserveIds
HTTP Method : POST
Parameter Order : projectId
▼ ▲ datastore.projects.beginTransaction
Path : v1/projects/{projectId}:beginTransaction
Scopes :
Description : Begins a new transaction.
HTTP Method : POST
Flat Path : v1/projects/{projectId}:beginTransaction
Parameters :
projectId
Description : Required. The ID of the project against which to make the request.
Type : string
Location : path
Required : Yes
Parameter Order : projectId
▼ ▲ datastore.projects.allocateIds
Description : Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.
Parameter Order : projectId
Scopes :
Flat Path : v1/projects/{projectId}:allocateIds
Path : v1/projects/{projectId}:allocateIds
HTTP Method : POST
Parameters :
projectId
Location : path
Type : string
Description : Required. The ID of the project against which to make the request.
Required : Yes
▼ ▲ datastore.projects.lookup
Flat Path : v1/projects/{projectId}:lookup
Parameter Order : projectId
Scopes :
Path : v1/projects/{projectId}:lookup
HTTP Method : POST
Description : Looks up entities by key.
Parameters :
projectId
Description : Required. The ID of the project against which to make the request.
Required : Yes
Location : path
Type : string
▼ ▲ datastore.projects.commit
Description : Commits a transaction, optionally creating, deleting or modifying some entities.
HTTP Method : POST
Parameter Order : projectId
Parameters :
projectId
Description : Required. The ID of the project against which to make the request.
Type : string
Required : Yes
Location : path
Scopes :
Path : v1/projects/{projectId}:commit
Flat Path : v1/projects/{projectId}:commit
▼ ▲ datastore.projects.runQuery
Parameter Order : projectId
Scopes :
Flat Path : v1/projects/{projectId}:runQuery
Description : Queries for entities.
Path : v1/projects/{projectId}:runQuery
HTTP Method : POST
Parameters :
projectId
Type : string
Description : Required. The ID of the project against which to make the request.
Required : Yes
Location : path
▼ ▲ datastore.projects.export
Flat Path : v1/projects/{projectId}:export
Scopes :
Description : Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
Path : v1/projects/{projectId}:export
HTTP Method : POST
Parameter Order : projectId
Parameters :
projectId
Location : path
Required : Yes
Description : Required. Project ID against which to make the request.
Type : string
▼ ▲ datastore.projects.runAggregationQuery
HTTP Method : POST
Path : v1/projects/{projectId}:runAggregationQuery
Description : Runs an aggregation query.
Flat Path : v1/projects/{projectId}:runAggregationQuery
Parameters :
projectId
Type : string
Description : Required. The ID of the project against which to make the request.
Required : Yes
Location : path
Parameter Order : projectId
Scopes :
▼ ▲ datastore.projects.import
Parameter Order : projectId
Scopes :
Path : v1/projects/{projectId}:import
Flat Path : v1/projects/{projectId}:import
HTTP Method : POST
Parameters :
projectId
Type : string
Location : path
Description : Required. Project ID against which to make the request.
Required : Yes
Description : Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.
▼ ▲ datastore.projects.rollback
Parameter Order : projectId
Description : Rolls back a transaction.
HTTP Method : POST
Path : v1/projects/{projectId}:rollback
Flat Path : v1/projects/{projectId}:rollback
Parameters :
projectId
Type : string
Required : Yes
Description : Required. The ID of the project against which to make the request.
Location : path
Scopes :