- databases-backupSchedules-create$
- databases-backupSchedules-delete$
- databases-backupSchedules-get$
- databases-backupSchedules-list$
- databases-backupSchedules-patch$
- databases-collectionGroups-fields-get$
- databases-collectionGroups-fields-list$
- databases-collectionGroups-fields-patch$
- databases-collectionGroups-indexes-create$
- databases-collectionGroups-indexes-delete$
- databases-collectionGroups-indexes-get$
- databases-collectionGroups-indexes-list$
- databases-create$
- databases-delete$
- databases-documents-batchGet$
- databases-documents-batchWrite$
- databases-documents-beginTransaction$
- databases-documents-commit$
- databases-documents-createDocument$
- databases-documents-delete$
- databases-documents-get$
- databases-documents-list$
- databases-documents-listCollectionIds$
- databases-documents-listDocuments$
- databases-documents-listen$
- databases-documents-partitionQuery$
- databases-documents-patch$
- databases-documents-rollback$
- databases-documents-runAggregationQuery$
- databases-documents-runQuery$
- databases-documents-write$
- databases-exportDocuments$
- databases-get$
- databases-importDocuments$
- databases-list$
- databases-operations-cancel$
- databases-operations-delete$
- databases-operations-get$
- databases-operations-list$
- databases-patch$
- databases-restore$
- locations-backups-delete$
- locations-backups-get$
- locations-backups-list$
- locations-get$
- locations-list$
happygapi.firestore.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
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-backupSchedules-create$clj
(databases-backupSchedules-create$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/create
Required parameters: parent
Optional parameters: none
Body:
{:name string, :createTime string, :updateTime string, :retention string, :dailyRecurrence {}, :weeklyRecurrence {:day string}}
Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:createTime string,
:updateTime string,
:retention string,
:dailyRecurrence {},
:weeklyRecurrence {:day string}}
Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.databases-backupSchedules-delete$clj
(databases-backupSchedules-delete$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/delete
Required parameters: name
Optional parameters: none
Deletes a backup schedule.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/delete Required parameters: name Optional parameters: none Deletes a backup schedule.
databases-backupSchedules-get$clj
(databases-backupSchedules-get$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/get
Required parameters: name
Optional parameters: none
Gets information about a backup schedule.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/get Required parameters: name Optional parameters: none Gets information about a backup schedule.
databases-backupSchedules-list$clj
(databases-backupSchedules-list$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/list
Required parameters: parent
Optional parameters: none
List backup schedules.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/list Required parameters: parent Optional parameters: none List backup schedules.
databases-backupSchedules-patch$clj
(databases-backupSchedules-patch$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :createTime string, :updateTime string, :retention string, :dailyRecurrence {}, :weeklyRecurrence {:day string}}
Updates a backup schedule.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/backupSchedules/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:createTime string,
:updateTime string,
:retention string,
:dailyRecurrence {},
:weeklyRecurrence {:day string}}
Updates a backup schedule.databases-collectionGroups-fields-get$clj
(databases-collectionGroups-fields-get$ auth parameters)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$clj
(databases-collectionGroups-fields-list$ auth parameters)Required parameters: parent
Optional parameters: filter, pageSize, pageToken
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 or ttlConfig:*.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/fields/list Required parameters: parent Optional parameters: filter, pageSize, pageToken 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` or `ttlConfig:*`.
databases-collectionGroups-fields-patch$clj
(databases-collectionGroups-fields-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :indexConfig {:indexes [GoogleFirestoreAdminV1Index], :usesAncestorConfig boolean, :ancestorField string, :reverting boolean}, :ttlConfig {:state 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:
{:name string,
:indexConfig {:indexes [GoogleFirestoreAdminV1Index],
:usesAncestorConfig boolean,
:ancestorField string,
:reverting boolean},
:ttlConfig {:state 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$clj
(databases-collectionGroups-indexes-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:name string, :queryScope string, :apiScope string, :fields [{:fieldPath string, :order string, :arrayConfig string, :vectorConfig GoogleFirestoreAdminV1VectorConfig}], :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,
:apiScope string,
:fields [{:fieldPath string,
:order string,
:arrayConfig string,
:vectorConfig GoogleFirestoreAdminV1VectorConfig}],
: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$clj
(databases-collectionGroups-indexes-delete$ auth parameters)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$clj
(databases-collectionGroups-indexes-get$ auth parameters)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$clj
(databases-collectionGroups-indexes-list$ auth parameters)Required parameters: parent
Optional parameters: filter, pageSize, pageToken
Lists composite indexes.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/collectionGroups/indexes/list Required parameters: parent Optional parameters: filter, pageSize, pageToken Lists composite indexes.
databases-create$clj
(databases-create$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/create
Required parameters: parent
Optional parameters: databaseId
Body:
{:cmekConfig {:kmsKeyName string, :activeKeyVersion [string]}, :deleteProtectionState string, :locationId string, :uid string, :name string, :createTime string, :appEngineIntegrationMode string, :type string, :etag string, :earliestVersionTime string, :concurrencyMode string, :versionRetentionPeriod string, :updateTime string, :keyPrefix string, :pointInTimeRecoveryEnablement string}
Create a database.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/create
Required parameters: parent
Optional parameters: databaseId
Body:
{:cmekConfig {:kmsKeyName string, :activeKeyVersion [string]},
:deleteProtectionState string,
:locationId string,
:uid string,
:name string,
:createTime string,
:appEngineIntegrationMode string,
:type string,
:etag string,
:earliestVersionTime string,
:concurrencyMode string,
:versionRetentionPeriod string,
:updateTime string,
:keyPrefix string,
:pointInTimeRecoveryEnablement string}
Create a database.databases-delete$clj
(databases-delete$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/delete
Required parameters: name
Optional parameters: etag
Deletes a database.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/delete Required parameters: name Optional parameters: etag Deletes a database.
databases-documents-batchGet$clj
(databases-documents-batchGet$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/batchGet
Required parameters: database
Optional parameters: none
Body:
{:documents [string], :mask {:fieldPaths [string]}, :transaction string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :readTime 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],
:mask {:fieldPaths [string]},
:transaction string,
:newTransaction {:readOnly ReadOnly, :readWrite ReadWrite},
:readTime 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-batchWrite$clj
(databases-documents-batchWrite$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/batchWrite
Required parameters: database
Optional parameters: none
Body:
{:writes [{:update Document, :delete string, :transform DocumentTransform, :updateMask DocumentMask, :updateTransforms [FieldTransform], :currentDocument Precondition}], :labels {}}
Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/batchWrite
Required parameters: database
Optional parameters: none
Body:
{:writes [{:update Document,
:delete string,
:transform DocumentTransform,
:updateMask DocumentMask,
:updateTransforms [FieldTransform],
:currentDocument Precondition}],
:labels {}}
Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.databases-documents-beginTransaction$clj
(databases-documents-beginTransaction$ auth parameters 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$clj
(databases-documents-commit$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/commit
Required parameters: database
Optional parameters: none
Body:
{:writes [{:update Document, :delete string, :transform DocumentTransform, :updateMask DocumentMask, :updateTransforms [FieldTransform], :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,
:delete string,
:transform DocumentTransform,
:updateMask DocumentMask,
:updateTransforms [FieldTransform],
:currentDocument Precondition}],
:transaction string}
Commits a transaction, while optionally updating documents.databases-documents-createDocument$clj
(databases-documents-createDocument$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/createDocument
Required parameters: parent, collectionId
Optional parameters: documentId, mask.fieldPaths
Body:
{:name string, :fields {}, :createTime string, :updateTime string}
Creates a new document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/createDocument
Required parameters: parent, collectionId
Optional parameters: documentId, mask.fieldPaths
Body:
{:name string, :fields {}, :createTime string, :updateTime string}
Creates a new document.databases-documents-delete$clj
(databases-documents-delete$ auth parameters)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$clj
(databases-documents-get$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/get
Required parameters: name
Optional parameters: mask.fieldPaths, transaction, readTime
Gets a single document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/get Required parameters: name Optional parameters: mask.fieldPaths, transaction, readTime Gets a single document.
databases-documents-list$clj
(databases-documents-list$ auth parameters)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$clj
(databases-documents-listCollectionIds$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:pageSize integer, :pageToken string, :readTime string}
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:
{:pageSize integer, :pageToken string, :readTime string}
Lists all the collection IDs underneath a document.databases-documents-listDocuments$clj
(databases-documents-listDocuments$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listDocuments
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/listDocuments Required parameters: collectionId, parent Optional parameters: mask.fieldPaths, transaction, pageToken, pageSize, readTime, showMissing, orderBy Lists documents.
databases-documents-listen$clj
(databases-documents-listen$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listen
Required parameters: database
Optional parameters: none
Body:
{:addTarget {:query QueryTarget, :documents DocumentsTarget, :resumeToken string, :readTime string, :targetId integer, :once boolean, :expectedCount integer}, :removeTarget integer, :labels {}}
Listens to changes. This method is only available via gRPC or WebChannel (not REST).
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/listen
Required parameters: database
Optional parameters: none
Body:
{:addTarget {:query QueryTarget,
:documents DocumentsTarget,
:resumeToken string,
:readTime string,
:targetId integer,
:once boolean,
:expectedCount integer},
:removeTarget integer,
:labels {}}
Listens to changes. This method is only available via gRPC or WebChannel (not REST).databases-documents-partitionQuery$clj
(databases-documents-partitionQuery$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/partitionQuery
Required parameters: parent
Optional parameters: none
Body:
{:structuredQuery {:select Projection, :from [CollectionSelector], :where Filter, :orderBy [Order], :startAt Cursor, :endAt Cursor, :offset integer, :limit integer}, :partitionCount string, :pageToken string, :pageSize integer, :readTime string}
Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/partitionQuery
Required parameters: parent
Optional parameters: none
Body:
{:structuredQuery {:select Projection,
:from [CollectionSelector],
:where Filter,
:orderBy [Order],
:startAt Cursor,
:endAt Cursor,
:offset integer,
:limit integer},
:partitionCount string,
:pageToken string,
:pageSize integer,
:readTime string}
Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.databases-documents-patch$clj
(databases-documents-patch$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/patch
Required parameters: name
Optional parameters: updateMask.fieldPaths, mask.fieldPaths, currentDocument.exists, currentDocument.updateTime
Body:
{:name string, :fields {}, :createTime string, :updateTime string}
Updates or inserts a document.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/patch
Required parameters: name
Optional parameters: updateMask.fieldPaths, mask.fieldPaths, currentDocument.exists, currentDocument.updateTime
Body:
{:name string, :fields {}, :createTime string, :updateTime string}
Updates or inserts a document.databases-documents-rollback$clj
(databases-documents-rollback$ auth parameters 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-runAggregationQuery$clj
(databases-documents-runAggregationQuery$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:structuredAggregationQuery {:structuredQuery StructuredQuery, :aggregations [Aggregation]}, :transaction string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :readTime string, :explainOptions {:analyze boolean}}
Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/runAggregationQuery
Required parameters: parent
Optional parameters: none
Body:
{:structuredAggregationQuery {:structuredQuery StructuredQuery,
:aggregations [Aggregation]},
:transaction string,
:newTransaction {:readOnly ReadOnly, :readWrite ReadWrite},
:readTime string,
:explainOptions {:analyze boolean}}
Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ```databases-documents-runQuery$clj
(databases-documents-runQuery$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/runQuery
Required parameters: parent
Optional parameters: none
Body:
{:structuredQuery {:select Projection, :from [CollectionSelector], :where Filter, :orderBy [Order], :startAt Cursor, :endAt Cursor, :offset integer, :limit integer}, :transaction string, :newTransaction {:readOnly ReadOnly, :readWrite ReadWrite}, :readTime string, :explainOptions {:analyze boolean}}
Runs a query.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/runQuery
Required parameters: parent
Optional parameters: none
Body:
{:structuredQuery {:select Projection,
:from [CollectionSelector],
:where Filter,
:orderBy [Order],
:startAt Cursor,
:endAt Cursor,
:offset integer,
:limit integer},
:transaction string,
:newTransaction {:readOnly ReadOnly, :readWrite ReadWrite},
:readTime string,
:explainOptions {:analyze boolean}}
Runs a query.databases-documents-write$clj
(databases-documents-write$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/write
Required parameters: database
Optional parameters: none
Body:
{:streamId string, :writes [{:update Document, :delete string, :transform DocumentTransform, :updateMask DocumentMask, :updateTransforms [FieldTransform], :currentDocument Precondition}], :streamToken string, :labels {}}
Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/documents/write
Required parameters: database
Optional parameters: none
Body:
{:streamId string,
:writes [{:update Document,
:delete string,
:transform DocumentTransform,
:updateMask DocumentMask,
:updateTransforms [FieldTransform],
:currentDocument Precondition}],
:streamToken string,
:labels {}}
Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).databases-exportDocuments$clj
(databases-exportDocuments$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/exportDocuments
Required parameters: name
Optional parameters: none
Body:
{:collectionIds [string], :outputUriPrefix string, :namespaceIds [string], :snapshotTime 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. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/exportDocuments
Required parameters: name
Optional parameters: none
Body:
{:collectionIds [string],
:outputUriPrefix string,
:namespaceIds [string],
:snapshotTime 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. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-importdatabases-get$clj
(databases-get$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/get
Required parameters: name
Optional parameters: none
Gets information about a database.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/get Required parameters: name Optional parameters: none Gets information about a database.
databases-importDocuments$clj
(databases-importDocuments$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/importDocuments
Required parameters: name
Optional parameters: none
Body:
{:collectionIds [string], :inputUriPrefix string, :namespaceIds [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,
:namespaceIds [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-list$clj
(databases-list$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/list
Required parameters: parent
Optional parameters: none
List all the databases in the project.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/list Required parameters: parent Optional parameters: none List all the databases in the project.
databases-operations-cancel$clj
(databases-operations-cancel$ auth parameters 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$clj
(databases-operations-delete$ auth parameters)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$clj
(databases-operations-get$ auth parameters)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$clj
(databases-operations-list$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
databases-patch$clj
(databases-patch$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:cmekConfig {:kmsKeyName string, :activeKeyVersion [string]}, :deleteProtectionState string, :locationId string, :uid string, :name string, :createTime string, :appEngineIntegrationMode string, :type string, :etag string, :earliestVersionTime string, :concurrencyMode string, :versionRetentionPeriod string, :updateTime string, :keyPrefix string, :pointInTimeRecoveryEnablement string}
Updates a database.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:cmekConfig {:kmsKeyName string, :activeKeyVersion [string]},
:deleteProtectionState string,
:locationId string,
:uid string,
:name string,
:createTime string,
:appEngineIntegrationMode string,
:type string,
:etag string,
:earliestVersionTime string,
:concurrencyMode string,
:versionRetentionPeriod string,
:updateTime string,
:keyPrefix string,
:pointInTimeRecoveryEnablement string}
Updates a database.databases-restore$clj
(databases-restore$ auth parameters body)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/restore
Required parameters: parent
Optional parameters: none
Body:
{:databaseId string, :backup string, :databaseSnapshot {:database string, :snapshotTime string}}
Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/databases/restore
Required parameters: parent
Optional parameters: none
Body:
{:databaseId string,
:backup string,
:databaseSnapshot {:database string, :snapshotTime string}}
Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.locations-backups-delete$clj
(locations-backups-delete$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/delete
Required parameters: name
Optional parameters: none
Deletes a backup.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/delete Required parameters: name Optional parameters: none Deletes a backup.
locations-backups-get$clj
(locations-backups-get$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/get
Required parameters: name
Optional parameters: none
Gets information about a backup.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/get Required parameters: name Optional parameters: none Gets information about a backup.
locations-backups-list$clj
(locations-backups-list$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/list
Required parameters: parent
Optional parameters: none
Lists all the backups.
https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/backups/list Required parameters: parent Optional parameters: none Lists all the backups.
locations-get$clj
(locations-get$ auth parameters)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$clj
(locations-list$ auth parameters)https://cloud.google.com/firestoreapi/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
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, pageSize, pageToken Lists information about the supported locations for this service.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close