Struct ProjectMethods

pub struct ProjectMethods<'a, C>
where
    C: 'a,
{ /* private fields */ }

A builder providing access to all methods supported on project resources. It is not used directly, but through the Firestore hub.

Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firestore1 as firestore1;

use firestore1::{Firestore, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

let secret: yup_oauth2::ApplicationSecret = Default::default();
let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = Firestore::new(client, auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `databases_backup_schedules_create(...)`, `databases_backup_schedules_delete(...)`, `databases_backup_schedules_get(...)`, `databases_backup_schedules_list(...)`, `databases_backup_schedules_patch(...)`, `databases_bulk_delete_documents(...)`, `databases_collection_groups_fields_get(...)`, `databases_collection_groups_fields_list(...)`, `databases_collection_groups_fields_patch(...)`, `databases_collection_groups_indexes_create(...)`, `databases_collection_groups_indexes_delete(...)`, `databases_collection_groups_indexes_get(...)`, `databases_collection_groups_indexes_list(...)`, `databases_create(...)`, `databases_delete(...)`, `databases_documents_batch_get(...)`, `databases_documents_batch_write(...)`, `databases_documents_begin_transaction(...)`, `databases_documents_commit(...)`, `databases_documents_create_document(...)`, `databases_documents_delete(...)`, `databases_documents_get(...)`, `databases_documents_list(...)`, `databases_documents_list_collection_ids(...)`, `databases_documents_list_documents(...)`, `databases_documents_listen(...)`, `databases_documents_partition_query(...)`, `databases_documents_patch(...)`, `databases_documents_rollback(...)`, `databases_documents_run_aggregation_query(...)`, `databases_documents_run_query(...)`, `databases_documents_write(...)`, `databases_export_documents(...)`, `databases_get(...)`, `databases_import_documents(...)`, `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(...)` and `locations_list(...)`
// to build up your call.
let rb = hub.projects();

Implementations

impl<'a, C> ProjectMethods<'a, C>

pub fn databases_backup_schedules_create( &self, request: GoogleFirestoreAdminV1BackupSchedule, parent: &str, ) -> ProjectDatabaseBackupScheduleCreateCall<'a, C>

Create a builder to help you perform the following task:

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

Arguments

• request - No description provided.
• parent - Required. The parent database. Format projects/{project}/databases/{database}

pub fn databases_backup_schedules_delete( &self, name: &str, ) -> ProjectDatabaseBackupScheduleDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a backup schedule.

Arguments

• name - Required. The name of the backup schedule. Format projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

pub fn databases_backup_schedules_get( &self, name: &str, ) -> ProjectDatabaseBackupScheduleGetCall<'a, C>

Create a builder to help you perform the following task:

Gets information about a backup schedule.

Arguments

• name - Required. The name of the backup schedule. Format projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

pub fn databases_backup_schedules_list( &self, parent: &str, ) -> ProjectDatabaseBackupScheduleListCall<'a, C>

Create a builder to help you perform the following task:

List backup schedules.

Arguments

• parent - Required. The parent database. Format is projects/{project}/databases/{database}.

pub fn databases_backup_schedules_patch( &self, request: GoogleFirestoreAdminV1BackupSchedule, name: &str, ) -> ProjectDatabaseBackupSchedulePatchCall<'a, C>

Create a builder to help you perform the following task:

Updates a backup schedule.

Arguments

• request - No description provided.
• name - Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

pub fn databases_collection_groups_fields_get( &self, name: &str, ) -> ProjectDatabaseCollectionGroupFieldGetCall<'a, C>

Create a builder to help you perform the following task:

Gets the metadata and configuration for a Field.

Arguments

• name - Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

pub fn databases_collection_groups_fields_list( &self, parent: &str, ) -> ProjectDatabaseCollectionGroupFieldListCall<'a, C>

Create a builder to help you perform the following task:

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:*.

Arguments

• parent - Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

pub fn databases_collection_groups_fields_patch( &self, request: GoogleFirestoreAdminV1Field, name: &str, ) -> ProjectDatabaseCollectionGroupFieldPatchCall<'a, C>

Create a builder to help you perform the following task:

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/*.

Arguments

• request - No description provided.
• name - Required. A field name of the form: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} A field path can be a simple field name, e.g. address or a path to fields within map_value , e.g. address.city, or a special field path. The only valid special field is *, which represents any field. Field paths can be quoted using ` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: *, ., ` (backtick), [, ], as well as any ascii symbolic characters. Examples: `address.city` represents a field named address.city, not the map key city in the field address. `*` represents a field named *, not any field. A special Field contains the default indexing settings for all fields. This field’s resource name is: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indexes defined on this Field will be applied to all fields which do not have their own Field index configuration.

pub fn databases_collection_groups_indexes_create( &self, request: GoogleFirestoreAdminV1Index, parent: &str, ) -> ProjectDatabaseCollectionGroupIndexCreateCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• parent - Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

pub fn databases_collection_groups_indexes_delete( &self, name: &str, ) -> ProjectDatabaseCollectionGroupIndexDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a composite index.

Arguments

• name - Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

pub fn databases_collection_groups_indexes_get( &self, name: &str, ) -> ProjectDatabaseCollectionGroupIndexGetCall<'a, C>

Create a builder to help you perform the following task:

Gets a composite index.

Arguments

• name - Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

pub fn databases_collection_groups_indexes_list( &self, parent: &str, ) -> ProjectDatabaseCollectionGroupIndexListCall<'a, C>

Create a builder to help you perform the following task:

Lists composite indexes.

Arguments

• parent - Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

pub fn databases_documents_batch_get( &self, request: BatchGetDocumentsRequest, database: &str, ) -> ProjectDatabaseDocumentBatchGetCall<'a, C>

Create a builder to help you perform the following task:

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_batch_write( &self, request: BatchWriteRequest, database: &str, ) -> ProjectDatabaseDocumentBatchWriteCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_begin_transaction( &self, request: BeginTransactionRequest, database: &str, ) -> ProjectDatabaseDocumentBeginTransactionCall<'a, C>

Create a builder to help you perform the following task:

Starts a new transaction.

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_commit( &self, request: CommitRequest, database: &str, ) -> ProjectDatabaseDocumentCommitCall<'a, C>

Create a builder to help you perform the following task:

Commits a transaction, while optionally updating documents.

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_create_document( &self, request: Document, parent: &str, collection_id: &str, ) -> ProjectDatabaseDocumentCreateDocumentCall<'a, C>

Create a builder to help you perform the following task:

Creates a new document.

Arguments

• request - No description provided.
• parent - Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}
• collectionId - Required. The collection ID, relative to parent, to list. For example: chatrooms.

pub fn databases_documents_delete( &self, name: &str, ) -> ProjectDatabaseDocumentDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a document.

Arguments

• name - Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

pub fn databases_documents_get( &self, name: &str, ) -> ProjectDatabaseDocumentGetCall<'a, C>

Create a builder to help you perform the following task:

Gets a single document.

Arguments

• name - Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

pub fn databases_documents_list( &self, parent: &str, collection_id: &str, ) -> ProjectDatabaseDocumentListCall<'a, C>

Create a builder to help you perform the following task:

Lists documents.

Arguments

• parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
• collectionId - Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

pub fn databases_documents_list_collection_ids( &self, request: ListCollectionIdsRequest, parent: &str, ) -> ProjectDatabaseDocumentListCollectionIdCall<'a, C>

Create a builder to help you perform the following task:

Lists all the collection IDs underneath a document.

Arguments

• request - No description provided.
• parent - Required. The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

pub fn databases_documents_list_documents( &self, parent: &str, collection_id: &str, ) -> ProjectDatabaseDocumentListDocumentCall<'a, C>

Create a builder to help you perform the following task:

Lists documents.

Arguments

• parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
• collectionId - Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

pub fn databases_documents_listen( &self, request: ListenRequest, database: &str, ) -> ProjectDatabaseDocumentListenCall<'a, C>

Create a builder to help you perform the following task:

Listens to changes. This method is only available via gRPC or WebChannel (not REST).

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_partition_query( &self, request: PartitionQueryRequest, parent: &str, ) -> ProjectDatabaseDocumentPartitionQueryCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

pub fn databases_documents_patch( &self, request: Document, name: &str, ) -> ProjectDatabaseDocumentPatchCall<'a, C>

Create a builder to help you perform the following task:

Updates or inserts a document.

Arguments

• request - No description provided.
• name - The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}.

pub fn databases_documents_rollback( &self, request: RollbackRequest, database: &str, ) -> ProjectDatabaseDocumentRollbackCall<'a, C>

Create a builder to help you perform the following task:

Rolls back a transaction.

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

pub fn databases_documents_run_aggregation_query( &self, request: RunAggregationQueryRequest, parent: &str, ) -> ProjectDatabaseDocumentRunAggregationQueryCall<'a, C>

Create a builder to help you perform the following task:

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 );

Arguments

• request - No description provided.
• parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

pub fn databases_documents_run_query( &self, request: RunQueryRequest, parent: &str, ) -> ProjectDatabaseDocumentRunQueryCall<'a, C>

Create a builder to help you perform the following task:

Runs a query.

Arguments

• request - No description provided.
• parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

pub fn databases_documents_write( &self, request: WriteRequest, database: &str, ) -> ProjectDatabaseDocumentWriteCall<'a, C>

Create a builder to help you perform the following task:

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

Arguments

• request - No description provided.
• database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

pub fn databases_operations_cancel( &self, request: GoogleLongrunningCancelOperationRequest, name: &str, ) -> ProjectDatabaseOperationCancelCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• name - The name of the operation resource to be cancelled.

pub fn databases_operations_delete( &self, name: &str, ) -> ProjectDatabaseOperationDeleteCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• name - The name of the operation resource to be deleted.

pub fn databases_operations_get( &self, name: &str, ) -> ProjectDatabaseOperationGetCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• name - The name of the operation resource.

pub fn databases_operations_list( &self, name: &str, ) -> ProjectDatabaseOperationListCall<'a, C>

Create a builder to help you perform the following task:

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

Arguments

• name - The name of the operation’s parent resource.

pub fn databases_bulk_delete_documents( &self, request: GoogleFirestoreAdminV1BulkDeleteDocumentsRequest, name: &str, ) -> ProjectDatabaseBulkDeleteDocumentCall<'a, C>

Create a builder to help you perform the following task:

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

Arguments

• request - No description provided.
• name - Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.

pub fn databases_create( &self, request: GoogleFirestoreAdminV1Database, parent: &str, ) -> ProjectDatabaseCreateCall<'a, C>

Create a builder to help you perform the following task:

Create a database.

Arguments

• request - No description provided.
• parent - Required. A parent name of the form projects/{project_id}

pub fn databases_delete(&self, name: &str) -> ProjectDatabaseDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a database.

Arguments

• name - Required. A name of the form projects/{project_id}/databases/{database_id}

pub fn databases_export_documents( &self, request: GoogleFirestoreAdminV1ExportDocumentsRequest, name: &str, ) -> ProjectDatabaseExportDocumentCall<'a, C>

Create a builder to help you perform the following task:

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

Arguments

• request - No description provided.
• name - Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.

pub fn databases_get(&self, name: &str) -> ProjectDatabaseGetCall<'a, C>

Create a builder to help you perform the following task:

Gets information about a database.

Arguments

• name - Required. A name of the form projects/{project_id}/databases/{database_id}

pub fn databases_import_documents( &self, request: GoogleFirestoreAdminV1ImportDocumentsRequest, name: &str, ) -> ProjectDatabaseImportDocumentCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• name - Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

pub fn databases_list(&self, parent: &str) -> ProjectDatabaseListCall<'a, C>

Create a builder to help you perform the following task:

List all the databases in the project.

Arguments

• parent - Required. A parent name of the form projects/{project_id}

pub fn databases_patch( &self, request: GoogleFirestoreAdminV1Database, name: &str, ) -> ProjectDatabasePatchCall<'a, C>

Create a builder to help you perform the following task:

Updates a database.

Arguments

• request - No description provided.
• name - The resource name of the Database. Format: projects/{project}/databases/{database}

pub fn databases_restore( &self, request: GoogleFirestoreAdminV1RestoreDatabaseRequest, parent: &str, ) -> ProjectDatabaseRestoreCall<'a, C>

Create a builder to help you perform the following task:

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.

Arguments

• request - No description provided.
• parent - Required. The project to restore the database in. Format is projects/{project_id}.

pub fn locations_backups_delete( &self, name: &str, ) -> ProjectLocationBackupDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a backup.

Arguments

• name - Required. Name of the backup to delete. format is projects/{project}/locations/{location}/backups/{backup}.

pub fn locations_backups_get( &self, name: &str, ) -> ProjectLocationBackupGetCall<'a, C>

Create a builder to help you perform the following task:

Gets information about a backup.

Arguments

• name - Required. Name of the backup to fetch. Format is projects/{project}/locations/{location}/backups/{backup}.

pub fn locations_backups_list( &self, parent: &str, ) -> ProjectLocationBackupListCall<'a, C>

Create a builder to help you perform the following task:

Lists all the backups.

Arguments

• parent - Required. The location to list backups from. Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.

pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, C>

Create a builder to help you perform the following task:

Gets information about a location.

Arguments

• name - Resource name for the location.

pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, C>

Create a builder to help you perform the following task:

Lists information about the supported locations for this service.

Arguments

• name - The resource that owns the locations collection, if applicable.

Trait Implementations

impl<'a, C> MethodsBuilder for ProjectMethods<'a, C>