happygapi.datastore.projects — happygapi 0.2.0

Cloud Datastore API: projects. Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.

See: https://cloud.google.com/datastore/api/reference/rest/v1/projects

allocateIds$ clj

(allocateIds$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/allocateIds

Required parameters: projectId

Optional parameters: none

Body:

{:keys [{:path [PathElement], :partitionId PartitionId}]}

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

beginTransaction$ clj

(beginTransaction$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/beginTransaction

Required parameters: projectId

Optional parameters: none

Body:

{:transactionOptions {:readWrite ReadWrite, :readOnly ReadOnly}}

Begins a new transaction.

commit$ clj

(commit$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/commit

Required parameters: projectId

Optional parameters: none

Body:

{:mutations [{:delete Key, :insert Entity, :baseVersion string, :update Entity, :upsert Entity}], :transaction string, :mode string}

Commits a transaction, optionally creating, deleting or modifying some entities.

export$ clj

(export$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/export

Required parameters: projectId

Optional parameters: none

Body:

{:entityFilter {:namespaceIds [string], :kinds [string]}, :outputUrlPrefix string, :labels {}}

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.

import$ clj

(import$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/import

Required parameters: projectId

Optional parameters: none

Body:

{:labels {}, :inputUrl string, :entityFilter {:namespaceIds [string], :kinds [string]}}

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.

indexes-create$ clj

(indexes-create$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/indexes/create

Required parameters: projectId

Optional parameters: none

Body:

{:properties [{:direction string, :name string}], :indexId string, :state string, :projectId string, :ancestor string, :kind string}

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.

indexes-delete$ clj

(indexes-delete$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/indexes/delete

Required parameters: projectId, indexId

Optional parameters: none 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.

indexes-get$ clj

(indexes-get$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/indexes/get

Required parameters: projectId, indexId

Optional parameters: none Gets an index.

indexes-list$ clj

(indexes-list$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/indexes/list

Required parameters: projectId

Optional parameters: filter, pageToken, pageSize 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.

lookup$ clj

(lookup$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/lookup

Required parameters: projectId

Optional parameters: none

Body:

{:readOptions {:readConsistency string, :transaction string}, :keys [{:path [PathElement], :partitionId PartitionId}]}

Looks up entities by key.

operations-cancel$ clj

(operations-cancel$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/operations/cancel

Required parameters: name

Optional parameters: none 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.

operations-delete$ clj

(operations-delete$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/operations/delete

Required parameters: name

Optional parameters: none 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.

operations-get$ clj

(operations-get$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/operations/get

Required parameters: name

Optional parameters: none 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.

operations-list$ clj

(operations-list$ auth args)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/operations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

reserveIds$ clj

(reserveIds$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/reserveIds

Required parameters: projectId

Optional parameters: none

Body:

{:keys [{:path [PathElement], :partitionId PartitionId}], :databaseId string}

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

rollback$ clj

(rollback$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/rollback

Required parameters: projectId

Optional parameters: none

Body:

{:transaction string}

Rolls back a transaction.

runQuery$ clj

(runQuery$ auth args body)

https://cloud.google.com/datastore/api/reference/rest/v1/projects/runQuery

Required parameters: projectId

Optional parameters: none

Body:

{:partitionId {:namespaceId string, :projectId string}, :gqlQuery {:queryString string, :allowLiterals boolean, :namedBindings {}, :positionalBindings [GqlQueryParameter]}, :readOptions {:readConsistency string, :transaction string}, :query {:limit integer, :offset integer, :endCursor string, :filter Filter, :kind [KindExpression], :order [PropertyOrder], :distinctOn [PropertyReference], :projection [Projection], :startCursor string}}

Queries for entities.