Indice
-
FirestoreAdmin
(interface) -
Backup
(message) -
Backup.State
(énumération) -
BackupSchedule
(message) -
CreateBackupScheduleRequest
(message) -
CreateDatabaseMetadata
(message) -
CreateDatabaseRequest
(message) -
CreateIndexRequest
(message) -
DailyRecurrence
(message) -
Database
(messages) -
Database.AppEngineIntegrationMode
(énumération) -
Database.ConcurrencyMode
(énumération) -
Database.DatabaseType
(énumération) -
Database.DeleteProtectionState
(énumération) -
Database.PointInTimeRecoveryEnablement
(énumération) -
DeleteBackupRequest
(message) -
DeleteBackupScheduleRequest
(message) -
DeleteDatabaseMetadata
(message) -
DeleteDatabaseRequest
(message) -
DeleteIndexRequest
(message) -
ExportDocumentsMetadata
(message) -
ExportDocumentsRequest
(message) -
ExportDocumentsResponse
(message) -
Field
(message) -
Field.IndexConfig
(message) -
Field.TtlConfig
(message) -
Field.TtlConfig.State
(énumération) -
FieldOperationMetadata
(message) -
FieldOperationMetadata.IndexConfigDelta
(message) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(énumération) -
FieldOperationMetadata.TtlConfigDelta
(message) -
FieldOperationMetadata.TtlConfigDelta.ChangeType
(énumération) -
GetBackupRequest
(message) -
GetBackupScheduleRequest
(message) -
GetDatabaseRequest
(message) -
GetFieldRequest
(message) -
GetIndexRequest
(message) -
ImportDocumentsMetadata
(message) -
ImportDocumentsRequest
(message) -
Index
(message) -
Index.ApiScope
(énumération) -
Index.IndexField
(message) -
Index.IndexField.ArrayConfig
(énumération) -
Index.IndexField.Order
(énumération) -
Index.QueryScope
(énumération) -
Index.State
(énumération) -
IndexOperationMetadata
(message) -
ListBackupSchedulesRequest
(message) -
ListBackupSchedulesResponse
(message) -
ListBackupsRequest
(message) -
ListBackupsResponse
(message) -
ListDatabasesRequest
(message) -
ListDatabasesResponse
(message) -
ListFieldsRequest
(message) -
ListFieldsResponse
(message) -
ListIndexesRequest
(message) -
ListIndexesResponse
(message) -
LocationMetadata
(message) -
OperationState
(énumération) -
Progress
(message) -
RestoreDatabaseMetadata
(message) -
RestoreDatabaseRequest
(message) -
UpdateBackupScheduleRequest
(message) -
UpdateDatabaseMetadata
(message) -
UpdateDatabaseRequest
(message) -
UpdateFieldRequest
(message) -
WeeklyRecurrence
(message)
Administrateur Firestore
L'API d'administration Cloud Firestore.
Cette API fournit plusieurs services d'administration pour Cloud Firestore.
Le projet, la base de données, l'espace de noms, la collection, le groupe de collections et le document sont utilisés tels que définis dans l'API Google Cloud Firestore.
Opération : une opération représente un travail effectué en arrière-plan.
Le service d'index gère les index Cloud Firestore.
La création d'index est effectuée de manière asynchrone. Une ressource Opération est créée pour chacune de ces opérations asynchrones. L'état de l'opération (y compris les erreurs rencontrées) peut être interrogé via la ressource Opération.
La collection Operations fournit un enregistrement des actions effectuées pour le projet spécifié (y compris les opérations en cours). Les opérations ne sont pas créées directement mais via des appels à d'autres collections ou ressources.
Une opération effectuée peut être supprimée afin qu'elle ne soit plus répertoriée dans la collection Operation. Les opérations sont collectées après 30 jours. Par défaut, ListOperations ne renverra que les opérations en cours et celles ayant échoué. Pour répertorier les opérations terminées, émettez une requête ListOperations avec le filtre done: true
.
Les opérations sont créées par le service FirestoreAdmin
, mais sont accessibles via le service google.longrunning.Operations
.
Créer un calendrier de sauvegarde |
---|
Crée une planification de sauvegarde sur une base de données. Au maximum deux planifications de sauvegarde peuvent être configurées sur une base de données, une planification de sauvegarde quotidienne avec rétention jusqu'à 7 jours et une planification de sauvegarde hebdomadaire avec rétention jusqu'à 14 semaines.
|
Créer une base de données |
---|
Créez une base de données.
|
CréerIndex |
---|
Crée un index composite. Cela renvoie une
|
Supprimer la sauvegarde |
---|
Supprime une sauvegarde.
|
Supprimer le calendrier de sauvegarde |
---|
Supprime une planification de sauvegarde.
|
Supprimer la base de données |
---|
Supprime une base de données.
|
Supprimer l'index |
---|
Supprime un index composite.
|
ExporterDocuments |
---|
Exporte une copie de tout ou partie des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage. Les mises à jour récentes des documents peuvent ne pas être reflétées dans l'exportation. L'exportation s'effectue en arrière-plan et sa progression peut être surveillée et gérée via la ressource Opération créée. Le résultat d’un export ne peut être utilisé qu’une fois l’opération associée effectuée. Si une opération d'exportation est annulée avant la fin, elle peut laisser des données partielles dans Google Cloud Storage. Pour plus de détails sur le comportement d'exportation et le format de sortie, reportez-vous à : https://cloud.google.com/firestore/docs/manage-data/export-import
|
Relève-toi |
---|
Obtient des informations sur une sauvegarde.
|
GetBackupSchedule |
---|
Obtient des informations sur une planification de sauvegarde.
|
Obtenir la base de données |
---|
Obtient des informations sur une base de données.
|
ObtenirField |
---|
Obtient les métadonnées et la configuration d'un champ.
|
ObtenirIndex |
---|
Obtient un index composite.
|
Importer des documents |
---|
Importe des documents dans Google Cloud Firestore. Les documents existants portant le même nom sont écrasés. L'importation s'effectue en arrière-plan et sa progression peut être surveillée et gérée via la ressource Opération créée. Si une opération ImportDocuments est annulée, il est possible qu'un sous-ensemble de données ait déjà été importé dans Cloud Firestore.
|
Liste des plannings de sauvegarde |
---|
Répertoriez les planifications de sauvegarde.
|
Liste des sauvegardes |
---|
Répertorie toutes les sauvegardes.
|
ListeBases de données |
---|
Répertoriez toutes les bases de données du projet.
|
Champs de liste |
---|
Répertorie la configuration des champs et les métadonnées de cette base de données. Actuellement,
|
ListeIndex |
---|
Répertorie les index composites.
|
Restaurer la base de données |
---|
Crée une nouvelle base de données en restaurant à partir d'une sauvegarde existante. La nouvelle base de données doit se trouver dans la même région cloud ou emplacement multirégional que la sauvegarde existante. Cela se comporte de la même manière que [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], sauf qu'au lieu de créer une nouvelle base de données vide, une nouvelle base de données est créée avec le type de base de données, la configuration de l'index et les documents d'une sauvegarde existante. L'
|
Mettre à jour le calendrier de sauvegarde |
---|
Met à jour une planification de sauvegarde.
|
Mettre à jour la base de données |
---|
Met à jour une base de données.
|
Champ de mise à jour |
---|
Met à jour une configuration de champ. Actuellement, les mises à jour de champs s'appliquent uniquement à la configuration d'index à champ unique. Cependant, les appels à Cet appel renvoie une Pour configurer les paramètres de champ par défaut de la base de données, utilisez le
|
Sauvegarde
Une sauvegarde d'une base de données Cloud Firestore.
La sauvegarde contient tous les documents et configurations d'index pour la base de données donnée à un moment précis.
Des champs | |
---|---|
name | Sortie uniquement. Le nom de ressource unique de la sauvegarde. Le format est |
database | Sortie uniquement. Nom de la base de données Firestore d'où provient la sauvegarde. Le format est |
database_uid | Sortie uniquement. UUID4 généré par le système pour la base de données Firestore d'où provient la sauvegarde. |
snapshot_time | Sortie uniquement. La sauvegarde contient actuellement une copie cohérente en externe de la base de données. |
expire_time | Sortie uniquement. L'horodatage auquel cette sauvegarde expire. |
state | Sortie uniquement. L'état actuel de la sauvegarde. |
État
Indiquez l'état actuel de la sauvegarde.
Énumérations | |
---|---|
STATE_UNSPECIFIED | L'état n'est pas précisé. |
CREATING | La sauvegarde en attente est toujours en cours de création. Les opérations sur la sauvegarde seront rejetées dans cet état. |
READY | La sauvegarde est complète et prête à être utilisée. |
NOT_AVAILABLE | La sauvegarde n'est pas disponible pour le moment. |
Planification de sauvegarde
Une planification de sauvegarde pour une base de données Cloud Firestore.
Cette ressource appartient à la base de données qu'elle sauvegarde et est supprimée avec la base de données. Les sauvegardes réelles ne le sont pas.
Des champs | |
---|---|
name | Sortie uniquement. L'identifiant unique de planification de sauvegarde sur tous les emplacements et bases de données pour le projet donné. Celui-ci sera attribué automatiquement. Le format est |
create_time | Sortie uniquement. L'horodatage auquel cette planification de sauvegarde a été créée et effective depuis. Aucune sauvegarde ne sera créée pour cette planification avant cette heure. |
update_time | Sortie uniquement. Horodatage auquel cette planification de sauvegarde a été mise à jour pour la dernière fois. Lorsqu'une planification de sauvegarde est créée pour la première fois, c'est la même chose que create_time. |
retention | À quelle heure relative dans le futur, par rapport à son heure de création, la sauvegarde doit être supprimée, par exemple conserver les sauvegardes pendant 7 jours. |
recurrence du champ Union. Un champ unique pour représenter le moment où les sauvegardes seront effectuées. recurrence ne peut être que l’un des éléments suivants : | |
daily_recurrence | Pour un planning qui s'exécute quotidiennement à une heure spécifiée. |
weekly_recurrence | Pour un planning qui s'exécute chaque semaine à un jour et une heure spécifiques. |
CreateBackupScheduleRequest
La demande de FirestoreAdmin.CreateBackupSchedule
.
Des champs | |
---|---|
parent | Requis. La base de données parent. Formater |
backup_schedule | Requis. La planification de sauvegarde à créer. |
CreateDatabaseMetadata
Ce type n'a pas de champs.
Métadonnées liées à l'opération de création de base de données.
CreateDatabaseRequest
La demande de FirestoreAdmin.CreateDatabase
.
Des champs | |
---|---|
parent | Requis. Un nom parent du formulaire |
database | Requis. La base de données à créer. |
database_id | Requis. L'ID à utiliser pour la base de données, qui deviendra le composant final du nom de ressource de la base de données. Cette valeur doit comporter entre 4 et 63 caractères. Les caractères valides sont /[az][0-9]-/ avec le premier caractère une lettre et le dernier une lettre ou un chiffre. Ne doit pas être de type UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. L'identifiant de la base de données "(par défaut)" est également valide. |
CreateIndexRequest
La demande de FirestoreAdmin.CreateIndex
.
Des champs | |
---|---|
parent | Requis. Un nom parent du formulaire |
index | Requis. L'index composite à créer. |
Récurrence quotidienne
Ce type n'a pas de champs.
Représente une planification récurrente qui s’exécute à une heure précise chaque jour.
Le fuseau horaire est UTC.
Base de données
Une base de données Cloud Firestore.
Des champs | |
---|---|
name | Le nom de ressource de la base de données. Format : |
uid | Sortie uniquement. UUID4 généré par le système pour cette base de données. |
create_time | Sortie uniquement. L'horodatage auquel cette base de données a été créée. Les bases de données créées avant 2016 ne remplissent pas create_time. |
update_time | Sortie uniquement. L'horodatage auquel cette base de données a été mise à jour pour la dernière fois. Notez que cela inclut uniquement les mises à jour de la ressource de base de données et non les données contenues dans la base de données. |
location_id | L'emplacement de la base de données. Les emplacements disponibles sont répertoriés sur https://cloud.google.com/firestore/docs/locations . |
type | Le type de la base de données. Voir https://cloud.google.com/datastore/docs/firestore-or-datastore pour plus d'informations sur la façon de choisir. |
concurrency_mode | Le mode de contrôle de concurrence à utiliser pour cette base de données. |
version_retention_period | Sortie uniquement. La période pendant laquelle les versions antérieures des données sont conservées dans la base de données. Toute Si la fonctionnalité PITR est activée, la période de conservation est de 7 jours. Dans le cas contraire, la durée de conservation est de 1 heure. |
earliest_version_time | Sortie uniquement. Horodatage le plus ancien auquel les anciennes versions des données peuvent être lues à partir de la base de données. Voir [version_retention_period] ci-dessus ; ce champ est renseigné avec Cette valeur est continuellement mise à jour et devient obsolète dès qu'elle est interrogée. Si vous utilisez cette valeur pour récupérer des données, assurez-vous de prendre en compte le temps écoulé entre le moment où la valeur est interrogée et le moment où vous lancez la récupération. |
point_in_time_recovery_enablement | S'il faut activer la fonctionnalité PITR sur cette base de données. |
app_engine_integration_mode | Mode d'intégration App Engine à utiliser pour cette base de données. |
key_prefix | Sortie uniquement. Le key_prefix pour cette base de données. Ce key_prefix est utilisé, en combinaison avec l'identifiant du projet (" Cette valeur peut être vide, auquel cas l'appid à utiliser pour les clés codées en URL est le project_id (par exemple : foo au lieu de v~foo). |
delete_protection_state | État de protection contre la suppression de la base de données. |
etag | Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs et peut être envoyée lors des demandes de mise à jour et de suppression pour garantir que le client dispose d'une valeur à jour avant de continuer. |
AppEngineIntegrationMode
Type de mode d'intégration App Engine.
Énumérations | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED | Non utilisé. |
ENABLED | Si une application App Engine existe dans la même région que cette base de données, la configuration App Engine aura un impact sur cette base de données. Cela inclut la désactivation de l'application et de la base de données, ainsi que la désactivation des écritures dans la base de données. |
DISABLED | App Engine n'a aucun effet sur la capacité de cette base de données à répondre aux requêtes. Il s'agit du paramètre par défaut pour les bases de données créées avec l'API Firestore. |
Mode Concurrence
Le type de mode de contrôle de concurrence pour les transactions.
Énumérations | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED | Non utilisé. |
OPTIMISTIC | Utilisez le contrôle de concurrence optimiste par défaut. Ce mode est disponible pour les bases de données Cloud Firestore. |
PESSIMISTIC | Utilisez le contrôle de concurrence pessimiste par défaut. Ce mode est disponible pour les bases de données Cloud Firestore. Il s'agit du paramètre par défaut pour Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS | Utilisez le contrôle de concurrence optimiste avec les groupes d'entités par défaut. Il s'agit du seul mode disponible pour Cloud Datastore. Ce mode est également disponible pour Cloud Firestore avec le mode Datastore mais n'est pas recommandé. |
Type de base de données
Le type de la base de données. Voir https://cloud.google.com/datastore/docs/firestore-or-datastore pour plus d'informations sur la façon de choisir.
Les changements de mode ne sont autorisés que si la base de données est vide.
Énumérations | |
---|---|
DATABASE_TYPE_UNSPECIFIED | La valeur par défaut. Cette valeur est utilisée si le type de base de données est omis. |
FIRESTORE_NATIVE | Mode natif de Firestore |
DATASTORE_MODE | Firestore en mode banque de données. |
Supprimer l'état de protection
L’état de protection contre la suppression de la base de données.
Énumérations | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED | La valeur par défaut. Le type de protection contre la suppression n'est pas spécifié |
DELETE_PROTECTION_DISABLED | La protection contre la suppression est désactivée |
DELETE_PROTECTION_ENABLED | La protection contre la suppression est activée |
PointInTimeRecoveryEnablement
Activation de la fonctionnalité de récupération ponctuelle.
Énumérations | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED | Non utilisé. |
POINT_IN_TIME_RECOVERY_ENABLED | Les lectures sont prises en charge sur certaines versions des données des 7 derniers jours :
|
POINT_IN_TIME_RECOVERY_DISABLED | Les lectures sont prises en charge sur n’importe quelle version des données datant de la dernière heure. |
Supprimer la demande de sauvegarde
La demande de FirestoreAdmin.DeleteBackup
.
Des champs | |
---|---|
name | Requis. Nom de la sauvegarde à supprimer. le format est |
Supprimer la demande de sauvegarde
La demande de [FirestoreAdmin.DeleteBackupSchedules][].
Des champs | |
---|---|
name | Requis. Le nom de la planification de sauvegarde. Formater |
Supprimer les métadonnées de la base de données
Ce type n'a pas de champs.
Métadonnées liées à l'opération de suppression de la base de données.
Supprimer la requête de base de données
La demande de FirestoreAdmin.DeleteDatabase
.
Des champs | |
---|---|
name | Requis. Un nom du formulaire |
etag | L'étiquette actuelle de la base de données. Si un etag est fourni et ne correspond pas à l'etag actuel de la base de données, la suppression sera bloquée et une erreur FAILED_PRECONDITION sera renvoyée. |
SupprimerIndexRequest
La demande de FirestoreAdmin.DeleteIndex
.
Des champs | |
---|---|
name | Requis. Un nom du formulaire |
ExportDocumentsMétadonnées
Métadonnées pour google.longrunning.Operation
résultats de FirestoreAdmin.ExportDocuments
.
Des champs | |
---|---|
start_time | L’heure à laquelle cette opération a commencé. |
end_time | Heure à laquelle cette opération s'est terminée. Sera désactivé si l’opération est toujours en cours. |
operation_state | L’état de l’opération d’exportation. |
progress_documents | Le déroulement, en documents, de cette opération. |
progress_bytes | La progression, en octets, de cette opération. |
collection_ids[] | Quels identifiants de collection sont exportés. |
output_uri_prefix | Où les documents sont exportés. |
namespace_ids[] | Quels identifiants d'espace de noms sont exportés. |
snapshot_time | L'horodatage qui correspond à la version de la base de données en cours d'exportation. Si cela n’est pas précisé, il n’y a aucune garantie quant à la cohérence des documents exportés. |
ExportDocumentsRequest
La demande de FirestoreAdmin.ExportDocuments
.
Des champs | |
---|---|
name | Requis. Base de données à exporter. Doit être de la forme : |
collection_ids[] | Quels identifiants de collection exporter. Non spécifié signifie toutes les collections. |
output_uri_prefix | L’URI de sortie. Actuellement, ne prend en charge que les URI Google Cloud Storage de la forme : |
namespace_ids[] | Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation préférée pour les bases de données qui n'utilisent pas d'espaces de noms. Un élément de chaîne vide représente l'espace de noms par défaut. Cela doit être utilisé si la base de données contient des données dans des espaces de noms autres que ceux par défaut, mais ne souhaite pas les inclure. Chaque espace de noms de cette liste doit être unique. |
snapshot_time | L'horodatage qui correspond à la version de la base de données à exporter. L'horodatage doit être antérieur, arrondi à la minute près et ne doit pas être antérieur à |
ExportDocumentsRéponse
Renvoyé dans le champ de réponse google.longrunning.Operation
.
Des champs | |
---|---|
output_uri_prefix | Emplacement des fichiers de sortie. Cela peut être utilisé pour lancer une importation dans Cloud Firestore (ce projet ou un autre projet) une fois l'opération terminée avec succès. |
Champ
Représente un seul champ dans la base de données.
Les champs sont regroupés par leur « Groupe de collections », qui représente toutes les collections de la base de données avec le même identifiant.
Des champs | |
---|---|
name | Requis. Un nom de champ du Un chemin de champ peut être un simple nom de champ, par exemple Les chemins de champ peuvent être cités en utilisant Exemples : (Remarque : les commentaires ici sont écrits dans une syntaxe markdown, il y a donc une couche supplémentaire de backticks pour représenter un bloc de code) Un |
index_config | La configuration de l'index pour ce champ. Si elle n'est pas définie, l'indexation des champs reviendra à la configuration définie par l' |
ttl_config | La configuration TTL pour ce |
IndexConfig
La configuration de l'index pour ce champ.
Des champs | |
---|---|
indexes[] | Index pris en charge pour ce champ. |
uses_ancestor_config | Sortie uniquement. Lorsque c'est vrai, la configuration de l'index du |
ancestor_field | Sortie uniquement. Spécifie le nom de ressource du |
reverting | Sortie uniquement Lorsque c'est vrai, la configuration de l'index du |
TtlConfig
La configuration TTL (durée de vie) pour les documents pour lesquels ce Field
est défini.
Le stockage d'une valeur d'horodatage dans un champ compatible TTL sera traité comme l'heure d'expiration absolue du document. Les valeurs d'horodatage passées indiquent que le document peut expirer immédiatement. L’utilisation de tout autre type de données ou le fait de laisser le champ absent désactivera l’expiration du document individuel.
Des champs | |
---|---|
state | Sortie uniquement. L'état de la configuration TTL. |
État
L’état d’application de la configuration TTL à tous les documents.
Énumérations | |
---|---|
STATE_UNSPECIFIED | L'état est indéterminé ou inconnu. |
CREATING | Le TTL est appliqué. Il existe une opération active de longue durée pour suivre le changement. Les documents nouvellement rédigés auront des durées de vie appliquées comme demandé. Les TTL demandés sur les documents existants sont toujours en cours de traitement. Lorsque les TTL de tous les documents existants auront été traités, l'état passera à « ACTIF ». |
ACTIVE | Le TTL est actif pour tous les documents. |
NEEDS_REPAIR | La configuration TTL n'a pas pu être activée pour tous les documents existants. Les documents nouvellement rédigés continueront à voir leur durée de vie appliquée. Le LRO renvoyé lors de la dernière tentative d'activation du TTL pour ce Field a échoué et peut contenir plus de détails. |
FieldOperationMetadata
Métadonnées pour les résultats google.longrunning.Operation
de FirestoreAdmin.UpdateField
.
Des champs | |
---|---|
start_time | L’heure à laquelle cette opération a commencé. |
end_time | Heure à laquelle cette opération s'est terminée. Sera désactivé si l’opération est toujours en cours. |
field | Ressource de terrain sur laquelle cette opération agit. Par exemple : |
index_config_deltas[] | Une liste de |
state | L'état de l'opération. |
progress_documents | Le déroulement, en documents, de cette opération. |
progress_bytes | La progression, en octets, de cette opération. |
ttl_config_delta | Décrit les deltas de la configuration TTL. |
IndexConfigDelta
Informations sur une modification de configuration d’index.
Des champs | |
---|---|
change_type | Spécifie comment l'index change. |
index | L'index est en cours de modification. |
Changer le type
Spécifie comment l'index change.
Énumérations | |
---|---|
CHANGE_TYPE_UNSPECIFIED | Le type de changement n’est ni précisé ni connu. |
ADD | L'index à champ unique est en cours d'ajout. |
REMOVE | L'index à champ unique est supprimé. |
TtlConfigDelta
Informations sur une modification de configuration TTL.
Des champs | |
---|---|
change_type | Spécifie comment la configuration TTL change. |
Changer le type
Spécifie comment la configuration TTL change.
Énumérations | |
---|---|
CHANGE_TYPE_UNSPECIFIED | Le type de changement n’est ni précisé ni connu. |
ADD | La configuration TTL est en cours d'ajout. |
REMOVE | La configuration TTL est en cours de suppression. |
GetBackupRequest
La demande de FirestoreAdmin.GetBackup
.
Des champs | |
---|---|
name | Requis. Nom de la sauvegarde à récupérer. Le format est |
GetBackupScheduleRequest
La demande de FirestoreAdmin.GetBackupSchedule
.
Des champs | |
---|---|
name | Requis. Le nom de la planification de sauvegarde. Formater |
GetDatabaseRequest
La demande de FirestoreAdmin.GetDatabase
.
Des champs | |
---|---|
name | Requis. Un nom du formulaire |
ObtenirFieldRequest
La demande de FirestoreAdmin.GetField
.
Des champs | |
---|---|
name | Requis. Un nom du formulaire |
GetIndexRequest
La demande de FirestoreAdmin.GetIndex
.
Des champs | |
---|---|
name | Requis. Un nom du formulaire |
ImportDocumentsMétadonnées
Métadonnées pour les résultats google.longrunning.Operation
de FirestoreAdmin.ImportDocuments
.
Des champs | |
---|---|
start_time | L’heure à laquelle cette opération a commencé. |
end_time | Heure à laquelle cette opération s'est terminée. Sera désactivé si l’opération est toujours en cours. |
operation_state | L’état de l’opération d’importation. |
progress_documents | Le déroulement, en documents, de cette opération. |
progress_bytes | La progression, en octets, de cette opération. |
collection_ids[] | Quels identifiants de collection sont importés. |
input_uri_prefix | L'emplacement des documents en cours d'importation. |
namespace_ids[] | Quels identifiants d'espace de noms sont importés. |
ImportDocumentsRequest
La demande de FirestoreAdmin.ImportDocuments
.
Des champs | |
---|---|
name | Requis. Base de données dans laquelle importer. Doit être de la forme : |
collection_ids[] | Quels identifiants de collection importer. Non spécifié signifie toutes les collections incluses dans l'importation. |
input_uri_prefix | Emplacement des fichiers exportés. Cela doit correspondre au output_uri_prefix d’un ExportDocumentsResponse d’une exportation qui s’est terminée avec succès. Voir : |
namespace_ids[] | Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation préférée pour les bases de données qui n'utilisent pas d'espaces de noms. Un élément de chaîne vide représente l'espace de noms par défaut. Cela doit être utilisé si la base de données contient des données dans des espaces de noms autres que ceux par défaut, mais ne souhaite pas les inclure. Chaque espace de noms de cette liste doit être unique. |
Indice
Les index Cloud Firestore permettent des requêtes simples et complexes sur les documents d'une base de données.
Des champs | |
---|---|
name | Sortie uniquement. Un nom défini par le serveur pour cet index. La forme de ce nom pour les index composites sera : |
query_scope | Les index avec une portée de requête de collection spécifiée autorisent les requêtes sur une collection qui est l'enfant d'un document spécifique, spécifié au moment de la requête, et qui a le même ID de collection. Les index avec une portée de requête de groupe de collections spécifiée autorisent les requêtes sur toutes les collections issues d'un document spécifique, spécifié au moment de la requête, et qui ont le même identifiant de collection que cet index. |
api_scope | Portée de l'API prise en charge par cet index. |
fields[] | Les champs pris en charge par cet index. Pour les index composites, cela nécessite un minimum de 2 et un maximum de 100 champs. La dernière entrée de champ concerne toujours le chemin du champ Pour les index de champ unique, il s'agira toujours exactement d'une entrée avec un chemin de champ égal au chemin de champ du champ associé. |
state | Sortie uniquement. État de diffusion de l'index. |
APIScope
API Scope définit les API (Firestore Native ou Firestore en mode Datastore) prises en charge pour les requêtes.
Énumérations | |
---|---|
ANY_API | L'index ne peut être utilisé que par l'API de requête Firestore Native. C'est la valeur par défaut. |
DATASTORE_MODE_API | L'index ne peut être utilisé que par l'API de requête Firestore en mode Datastore. |
Champ d'index
Un champ dans un index. Le field_path décrit quel champ est indexé, le value_mode décrit comment la valeur du champ est indexée.
Des champs | |
---|---|
field_path | Peut être un nom . Pour les index à champ unique, cela doit correspondre au nom du champ ou peut être omis. |
Champ d'union value_mode . Comment la valeur du champ est indexée. value_mode ne peut être qu'un des éléments suivants : | |
order | Indique que ce champ prend en charge le tri selon l'ordre spécifié ou la comparaison à l'aide de =, !=, <, <=, >, >=. |
array_config | Indique que ce champ prend en charge les opérations sur |
TableauConfig
Configurations de valeurs de tableau prises en charge.
Énumérations | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | L'index ne prend pas en charge les requêtes de tableau supplémentaires. |
CONTAINS | L'index prend en charge les requêtes de confinement de tableau. |
Commande
Les commandes prises en charge.
Énumérations | |
---|---|
ORDER_UNSPECIFIED | L'ordre n'est pas précisé. Ce n'est pas une option valable. |
ASCENDING | Le champ est classé par valeur de champ croissante. |
DESCENDING | Le champ est classé par valeur de champ décroissante. |
Portée de la requête
La portée de la requête définit la portée dans laquelle une requête est exécutée. Ceci est spécifié dans le champ from
d'une requête structurée.
Énumérations | |
---|---|
QUERY_SCOPE_UNSPECIFIED | La portée de la requête n'est pas spécifiée. Ce n'est pas une option valable. |
COLLECTION | Les index avec une portée de requête de collection spécifiée autorisent les requêtes sur une collection qui est l'enfant d'un document spécifique, spécifié au moment de la requête, et qui possède l'ID de collection spécifié par l'index. |
COLLECTION_GROUP | Les index avec une étendue de requête de groupe de collections spécifiée autorisent les requêtes sur toutes les collections possédant l'ID de collection spécifié par l'index. |
COLLECTION_RECURSIVE | Incluez tous les ancêtres des collections dans l'index. Disponible uniquement pour les bases de données en mode banque de données. |
État
L'état d'un index. Lors de la création d’un index, un index sera dans l’état CREATING
. Si l'index est créé avec succès, il passera à l'état READY
. Si la création de l'index rencontre un problème, l'index passera à l'état NEEDS_REPAIR
.
Énumérations | |
---|---|
STATE_UNSPECIFIED | L'état n'est pas précisé. |
CREATING | L'index est en cours de création. Il existe une opération active de longue durée pour l’index. L'index est mis à jour lors de la rédaction d'un document. Certaines données d'index peuvent exister. |
READY | L'index est prêt à être utilisé. L'index est mis à jour lors de la rédaction d'un document. L'index est entièrement renseigné à partir de tous les documents stockés auxquels il s'applique. |
NEEDS_REPAIR | L'index était en cours de création, mais quelque chose s'est mal passé. Il n'y a pas d'opération de longue durée active pour l'index et l'opération de longue date terminée a échoué. L'index n'est pas mis à jour lors de la rédaction d'un document. Certaines données d'index peuvent exister. Utilisez l'API Google.longrunning.Operations pour déterminer pourquoi l'opération qui a tenté de créer cet index a échoué, puis recréer l'index. |
IndexOperationMetadata
Metadata pour google.longrunning.Operation
Résultats de FirestoreAdmin.CreateIndex
.
Des champs | |
---|---|
start_time | L'heure à laquelle cette opération a commencé. |
end_time | L'heure à laquelle cette opération a terminée. Ne sera pas défini si l'opération est toujours en cours. |
index | La ressource d'index sur laquelle cette opération agit. Par exemple: |
state | L'état de l'opération. |
progress_documents | Les progrès, dans les documents, de cette opération. |
progress_bytes | Les progrès, en octets, de cette opération. |
ListBackupSchedulesRequest
La demande de FirestoreAdmin.ListBackupSchedules
.
Des champs | |
---|---|
parent | Requis. La base de données parent. Le format est |
ListBackupSchedulesResponse
La réponse pour FirestoreAdmin.ListBackupSchedules
.
Des champs | |
---|---|
backup_schedules[] | Liste de tous les horaires de sauvegarde. |
ListBackupSrequest
La demande de FirestoreAdmin.ListBackups
.
Des champs | |
---|---|
parent | Requis. L'emplacement pour répertorier les sauvegardes. Le format est |
ListbackupsResponse
La réponse pour FirestoreAdmin.ListBackups
.
Des champs | |
---|---|
backups[] | Liste de toutes les sauvegardes du projet. |
unreachable[] | Liste des emplacements dont les sauvegardes existantes n'ont pas pu être récupérées. Au lieu d'échouer les demandes entières lorsqu'un seul emplacement est inaccessible, cette réponse renvoie un ensemble de résultats partiel et une liste des emplacements incapables d'être atteints ici. La demande peut être rejetée par rapport à un seul emplacement pour obtenir une erreur concrète. |
ListDatabasesRequest
Une demande pour répertorier les bases de données Firestore dans tous les emplacements pour un projet.
Des champs | |
---|---|
parent | Requis. Un nom de parent des |
ListDatabasesResponse
La liste des bases de données d'un projet.
Des champs | |
---|---|
databases[] | Les bases de données du projet. |
unreachable[] | Dans le cas où les données sur les bases de données individuelles ne peuvent pas être répertoriées, elles seront enregistrées ici. Un exemple d'entrée peut être: projets / some_project / emplacements / some_location Cela peut se produire si la région cloud dans laquelle la base de données réside est actuellement indisponible. Dans ce cas, nous ne pouvons pas récupérer tous les détails sur la base de données. Vous pourrez peut-être obtenir un message d'erreur plus détaillé (ou peut-être récupérer la ressource) en envoyant une demande «Get» pour la ressource ou une demande de «liste» pour l'emplacement spécifique. |
ListFieldsRequest
La demande de FirestoreAdmin.ListFields
.
Des champs | |
---|---|
parent | Requis. Un nom de parent des |
filter | Le filtre à s'appliquer à la liste des résultats. Actuellement, |
page_size | Le nombre de résultats à retourner. |
page_token | Un jeton de page, renvoyé d'un appel précédent à |
ListFieldsResponse
La réponse pour FirestoreAdmin.ListFields
.
Des champs | |
---|---|
fields[] | Les champs demandés. |
next_page_token | Un jeton de page qui peut être utilisé pour demander une autre page de résultats. Si vide, c'est la dernière page. |
ListIndexesRequest
La demande de FirestoreAdmin.ListIndexes
.
Des champs | |
---|---|
parent | Requis. Un nom de parent des |
filter | Le filtre à s'appliquer à la liste des résultats. |
page_size | Le nombre de résultats à retourner. |
page_token | Un jeton de page, retourné d'un appel précédent à |
ListIndexesResponse
La réponse pour FirestoreAdmin.ListIndexes
.
Des champs | |
---|---|
indexes[] | Les index demandés. |
next_page_token | Un jeton de page qui peut être utilisé pour demander une autre page de résultats. Si vide, c'est la dernière page. |
LocationMetadata
Ce type n'a pas de champs.
Le message des métadonnées pour google.cloud.location.Location.metadata
.
Opération d'opération
Décrit l'état de l'opération.
Énumérations | |
---|---|
OPERATION_STATE_UNSPECIFIED | Non spécifié. |
INITIALIZING | La demande est en cours de préparation pour le traitement. |
PROCESSING | La demande est en cours de traitement activement. |
CANCELLING | La demande est en train d'être annulée après que l'utilisateur a appelé Google.longrunning.operations.canceLolopération sur l'opération. |
FINALIZING | La demande a été traitée et en est à sa phase de finalisation. |
SUCCESSFUL | La demande s'est terminée avec succès. |
FAILED | La demande a fini d'être traitée, mais a rencontré une erreur. |
CANCELLED | La demande a fini d'être annulée après que l'utilisateur a appelé Google.longrunning.Operations.CanceLoloperation. |
Progrès
Décrit la progression de l'opération. L'unité de travail est générique et doit être interprétée en fonction de l'endroit où Progress
sont utilisés.
Des champs | |
---|---|
estimated_work | La quantité de travail estimée. |
completed_work | La quantité de travail terminée. |
Restauréatabasememetadata
Métadonnées pour l' long-running operation
de la demande [RestoreDatabase] [Google.Firestore.admin.v1.RestoreDatabase].
Des champs | |
---|---|
start_time | Le moment où la restauration a commencé. |
end_time | Le moment où la restauration s'est terminée, inférieure aux restaurations en cours. |
operation_state | L'état d'opération de la restauration. |
database | Le nom de la base de données en cours de restauration. |
backup | Le nom de la sauvegarde restaurant. |
progress_percentage | Jusqu'à quel point la restauration est en pourcentage estimé de temps restant. |
RestoredatabaseRequest
Le message de demande pour [Firestoreadmin.RestoreDatabase] [Google.Firestore.admin.v1.RestoreDatabase].
Des champs | |
---|---|
parent | Requis. Le projet pour restaurer la base |
database_id | Requis. L'ID à utiliser pour la base de données, qui deviendra le composant final du nom de ressource de la base de données. Cet ID de base de données ne doit pas être associé à une base de données existante. Cette valeur doit être de 4 à 63 caractères. Les caractères valides sont / [az] [0-9] - / avec le premier caractère une lettre et le dernier une lettre ou un nombre. Ne doit pas être uUID-like / [0-9a-f] {8} (- [0-9a-f] {4}) {3} - [0-9a-f] {12} /. L'ID de base de données "(par défaut) est également valide. |
| |
backup | Sauvegarde à restaurer à partir de. Doit provenir du même projet que le parent. Le format est: |
UpdateBackupscheduleRequest
La demande de FirestoreAdmin.UpdateBackupSchedule
.
Des champs | |
---|---|
backup_schedule | Requis. Le calendrier de sauvegarde à mettre à jour. |
update_mask | La liste des champs à mettre à jour. |
UpdatedatabaseMetadata
Ce type n'a pas de champs.
Métadonnées liées à l'opération de base de données de mise à jour.
UpdatedatabaseRequest
La demande de FirestoreAdmin.UpdateDatabase
.
Des champs | |
---|---|
database | Requis. La base de données à mettre à jour. |
update_mask | La liste des champs à mettre à jour. |
UpdateFieldRequest
La demande de FirestoreAdmin.UpdateField
.
Des champs | |
---|---|
field | Requis. Le champ à mettre à jour. |
update_mask | Un masque, par rapport au champ. Si spécifié, seule la configuration spécifiée par ce champ_mask sera mise à jour dans le champ. |
Recurrence hebdomadaire
Représente un calendrier récurrent qui fonctionne un jour spécifié de la semaine.
Le fuseau horaire est UTC.
Des champs | |
---|---|
day | Le jour de la semaine pour courir. Day_of_week_unspecified n'est pas autorisé. |