FirestoreAdminClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Operations are created by service FirestoreAdmin
, but are
accessed via service google.longrunning.Operations
.
Properties
transport
Return the transport used by the client instance.
Returns | |
---|---|
Type | Description |
FirestoreAdminTransport | The transport used by the client instance. |
Methods
FirestoreAdminClient
FirestoreAdminClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiate the firestore admin client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
client_options_lib.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
collection_group_path
collection_group_path(project: str, database: str, collection: str)
Return a fully-qualified collection_group string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return a fully-qualified project string.
create_index
create_index(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.CreateIndexRequest] = None, *, parent: Optional[str] = None, index: Optional[google.cloud.firestore_admin_v1.types.index.Index] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a composite index. This returns a
google.longrunning.Operation][google.longrunning.Operation]
which may be used to track the status of the creation. The
metadata for the operation will be the type
IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata]
.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
parent |
Required. A parent name of the form |
index |
Required. The composite index to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .gfa_index.Index |
database_path
database_path(project: str, database: str)
Return a fully-qualified database string.
delete_index
delete_index(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteIndexRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a composite index.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
name |
Required. A name of the form |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
export_documents
export_documents(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.ExportDocumentsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
name |
Required. Database to export. Should be of the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .gfa_operation.ExportDocumentsResponse google.longrunning.Operation][google.longrunning.Operation] response field. |
field_path
field_path(project: str, database: str, collection: str, field: str)
Return a fully-qualified field string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
get_field
get_field(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.GetFieldRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the metadata and configuration for a Field.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
name |
Required. A name of the form |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. |
get_index
get_index(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.GetIndexRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a composite index.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
name |
Required. A name of the form |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Cloud Firestore indexes enable simple and complex queries against documents in a database. |
import_documents
import_documents(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.ImportDocumentsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
name |
Required. Database to import into. Should be of the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .empty.Empty Empty is empty JSON object {} . |
index_path
index_path(project: str, database: str, collection: str, index: str)
Return a fully-qualified index string.
list_fields
list_fields(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.ListFieldsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists the field configuration and metadata for this database.
Currently,
FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
only supports listing fields that have been explicitly
overridden. To issue this query, call
FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
with the filter set to indexConfig.usesAncestorConfig:false
.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
parent |
Required. A parent name of the form |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| The response for FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] . Iterating over this object will yield results and resolve additional pages automatically. |
list_indexes
list_indexes(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.ListIndexesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists composite indexes.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
parent |
Required. A parent name of the form |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| The response for FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes] . Iterating over this object will yield results and resolve additional pages automatically. |
parse_collection_group_path
parse_collection_group_path(path: str)
Parse a collection_group path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_database_path
parse_database_path(path: str)
Parse a database path into its component segments.
parse_field_path
parse_field_path(path: str)
Parse a field path into its component segments.
parse_index_path
parse_index_path(path: str)
Parse a index path into its component segments.
update_field
update_field(request: Optional[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateFieldRequest] = None, *, field: Optional[google.cloud.firestore_admin_v1.types.field.Field] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a field configuration. Currently, field updates apply
only to single field index configuration. However, calls to
FirestoreAdmin.UpdateField][google.firestore.admin.v1.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][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][google.firestore.admin.v1.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/*
.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request for |
field |
Required. The field to be updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .gfa_field.Field |