Cloud Firestore API: projects. Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
See: https://cloud.google.com/firestoreapi/reference/rest/v1/projects
Cloud Firestore API: projects. Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. See: https://cloud.google.com/firestoreapi/reference/rest/v1/projects
(databases-collectionGroups-fields-get$ auth args)
Required parameters: name
Optional parameters: none Gets the metadata and configuration for a Field.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/fields/get Required parameters: name Optional parameters: none Gets the metadata and configuration for a Field.
(databases-collectionGroups-fields-list$ auth args)
Required parameters: parent
Optional parameters: filter, pageToken, pageSize Lists the field configuration and metadata for this database.
Currently, FirestoreAdmin.ListFields only supports listing fields
that have been explicitly overridden. To issue this query, call
FirestoreAdmin.ListFields with the filter set to
indexConfig.usesAncestorConfig:false
.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/fields/list Required parameters: parent Optional parameters: filter, pageToken, pageSize Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.
(databases-collectionGroups-fields-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:indexConfig {:ancestorField string, :indexes [GoogleFirestoreAdminV1Index], :usesAncestorConfig boolean, :reverting boolean}, :name string}
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
FirestoreAdmin.UpdateField should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }
.
This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata.
To configure the default field settings for the database, use
the special Field
with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*
.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/fields/patch Required parameters: name Optional parameters: updateMask Body: {:indexConfig {:ancestorField string, :indexes [GoogleFirestoreAdminV1Index], :usesAncestorConfig boolean, :reverting boolean}, :name string} Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
(databases-collectionGroups-indexes-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :queryScope string, :fields [{:fieldPath string, :order string, :arrayConfig string}], :state string}
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/indexes/create Required parameters: parent Optional parameters: none Body: {:name string, :queryScope string, :fields [{:fieldPath string, :order string, :arrayConfig string}], :state string} Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
(databases-collectionGroups-indexes-delete$ auth args)
Required parameters: name
Optional parameters: none Deletes a composite index.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/indexes/delete Required parameters: name Optional parameters: none Deletes a composite index.
(databases-collectionGroups-indexes-get$ auth args)
Required parameters: name
Optional parameters: none Gets a composite index.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/indexes/get Required parameters: name Optional parameters: none Gets a composite index.
(databases-collectionGroups-indexes-list$ auth args)
Required parameters: parent
Optional parameters: pageToken, pageSize, filter Lists composite indexes.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/indexes/list Required parameters: parent Optional parameters: pageToken, pageSize, filter Lists composite indexes.
(databases-documents-batchGet$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/batchGet
Required parameters: database
Optional parameters: none
Body:
{:documents [string], :readTime string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :mask {:fieldPaths [string]}, :transaction string}
Gets multiple documents.
Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/batchGet Required parameters: database Optional parameters: none Body: {:documents [string], :readTime string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :mask {:fieldPaths [string]}, :transaction string} Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
(databases-documents-beginTransaction$ auth args body)
Required parameters: database
Optional parameters: none
Body:
{:options {:readOnly ReadOnly, :readWrite ReadWrite}}
Starts a new transaction.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/beginTransaction Required parameters: database Optional parameters: none Body: {:options {:readOnly ReadOnly, :readWrite ReadWrite}} Starts a new transaction.
(databases-documents-commit$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/commit
Required parameters: database
Optional parameters: none
Body:
{:writes [{:update Document, :transform DocumentTransform, :delete string, :updateMask DocumentMask, :currentDocument Precondition}], :transaction string}
Commits a transaction, while optionally updating documents.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/commit Required parameters: database Optional parameters: none Body: {:writes [{:update Document, :transform DocumentTransform, :delete string, :updateMask DocumentMask, :currentDocument Precondition}], :transaction string} Commits a transaction, while optionally updating documents.
(databases-documents-createDocument$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/createDocument
Required parameters: collectionId, parent
Optional parameters: mask.fieldPaths, documentId
Body:
{:createTime string, :fields {}, :updateTime string, :name string}
Creates a new document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/createDocument Required parameters: collectionId, parent Optional parameters: mask.fieldPaths, documentId Body: {:createTime string, :fields {}, :updateTime string, :name string} Creates a new document.
(databases-documents-delete$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/delete
Required parameters: name
Optional parameters: currentDocument.exists, currentDocument.updateTime Deletes a document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/delete Required parameters: name Optional parameters: currentDocument.exists, currentDocument.updateTime Deletes a document.
(databases-documents-get$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/get
Required parameters: name
Optional parameters: mask.fieldPaths, readTime, transaction Gets a single document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/get Required parameters: name Optional parameters: mask.fieldPaths, readTime, transaction Gets a single document.
(databases-documents-list$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/list
Required parameters: collectionId, parent
Optional parameters: mask.fieldPaths, transaction, pageToken, pageSize, readTime, showMissing, orderBy Lists documents.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/list Required parameters: collectionId, parent Optional parameters: mask.fieldPaths, transaction, pageToken, pageSize, readTime, showMissing, orderBy Lists documents.
(databases-documents-listCollectionIds$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:pageToken string, :pageSize integer}
Lists all the collection IDs underneath a document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listCollectionIds Required parameters: parent Optional parameters: none Body: {:pageToken string, :pageSize integer} Lists all the collection IDs underneath a document.
(databases-documents-listen$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listen
Required parameters: database
Optional parameters: none
Body:
{:removeTarget integer, :addTarget {:query QueryTarget, :resumeToken string, :once boolean, :readTime string, :targetId integer, :documents DocumentsTarget}, :labels {}}
Listens to changes.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listen Required parameters: database Optional parameters: none Body: {:removeTarget integer, :addTarget {:query QueryTarget, :resumeToken string, :once boolean, :readTime string, :targetId integer, :documents DocumentsTarget}, :labels {}} Listens to changes.
(databases-documents-patch$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/patch
Required parameters: name
Optional parameters: currentDocument.exists, updateMask.fieldPaths, mask.fieldPaths, currentDocument.updateTime
Body:
{:createTime string, :fields {}, :updateTime string, :name string}
Updates or inserts a document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/patch Required parameters: name Optional parameters: currentDocument.exists, updateMask.fieldPaths, mask.fieldPaths, currentDocument.updateTime Body: {:createTime string, :fields {}, :updateTime string, :name string} Updates or inserts a document.
(databases-documents-rollback$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/rollback
Required parameters: database
Optional parameters: none
Body:
{:transaction string}
Rolls back a transaction.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/rollback Required parameters: database Optional parameters: none Body: {:transaction string} Rolls back a transaction.
(databases-documents-runQuery$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/runQuery
Required parameters: parent
Optional parameters: none
Body:
{:readTime string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :transaction string, :structuredQuery {:limit integer, :offset integer, :from [CollectionSelector], :endAt Cursor, :startAt Cursor, :where Filter, :orderBy [Order], :select Projection}}
Runs a query.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/runQuery Required parameters: parent Optional parameters: none Body: {:readTime string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :transaction string, :structuredQuery {:limit integer, :offset integer, :from [CollectionSelector], :endAt Cursor, :startAt Cursor, :where Filter, :orderBy [Order], :select Projection}} Runs a query.
(databases-documents-write$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/write
Required parameters: database
Optional parameters: none
Body:
{:streamToken string, :writes [{:update Document, :transform DocumentTransform, :delete string, :updateMask DocumentMask, :currentDocument Precondition}], :labels {}, :streamId string}
Streams batches of document updates and deletes, in order.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/write Required parameters: database Optional parameters: none Body: {:streamToken string, :writes [{:update Document, :transform DocumentTransform, :delete string, :updateMask DocumentMask, :currentDocument Precondition}], :labels {}, :streamId string} Streams batches of document updates and deletes, in order.
(databases-exportDocuments$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/exportDocuments
Required parameters: name
Optional parameters: none
Body:
{:outputUriPrefix string, :collectionIds [string]}
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents 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.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/exportDocuments Required parameters: name Optional parameters: none Body: {:outputUriPrefix string, :collectionIds [string]} Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents 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.
(databases-importDocuments$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/importDocuments
Required parameters: name
Optional parameters: none
Body:
{:collectionIds [string], :inputUriPrefix string}
Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/importDocuments Required parameters: name Optional parameters: none Body: {:collectionIds [string], :inputUriPrefix string} Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
(databases-operations-cancel$ auth args body)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
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
.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/cancel Required parameters: name Optional parameters: none Body: {} 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`.
(databases-operations-delete$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/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
.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/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`.
(databases-operations-get$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/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.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/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.
(databases-operations-list$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/list
Required parameters: name
Optional parameters: pageToken, pageSize, filter
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.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/list Required parameters: name Optional parameters: pageToken, pageSize, filter 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.
(locations-get$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/get
Required parameters: name
Optional parameters: none Gets information about a location.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth args)
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize Lists information about the supported locations for this service.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/list Required parameters: name Optional parameters: filter, pageToken, pageSize Lists information about the supported locations for this service.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close