Package google.firestore.admin.v1

string

Uniquement en sortie. Nom de ressource unique de la sauvegarde.

Format : projects/{project}/locations/{location}/backups/{backup}

string

Uniquement en sortie. Nom de la base de données Firestore dont provient la sauvegarde.

Format : projects/{project}/databases/{database}

string

Uniquement en sortie. UUID4 généré par le système pour la base de données Firestore à partir de laquelle provient la sauvegarde.

Timestamp

Uniquement en sortie. À l'heure actuelle, la sauvegarde contient une copie de la base de données cohérente en externe.

Timestamp

Uniquement en sortie. Horodatage de l'expiration de la sauvegarde.

State

Uniquement en sortie. État actuel de la sauvegarde.

string

Uniquement en sortie. Identifiant unique de programmation des sauvegardes pour tous les emplacements et toutes les bases de données du projet donné.

Ce champ sera attribué automatiquement.

Format : projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Timestamp

Uniquement en sortie. Horodatage de la création et de l'entrée en vigueur de ce planning de sauvegarde.

Aucune sauvegarde ne sera créée pour cette programmation avant cette date.

Timestamp

Uniquement en sortie. Horodatage de la dernière mise à jour de ce planning de sauvegarde. Lorsqu'une programmation de sauvegarde est créée pour la première fois, cela équivaut à create_time.

Duration

À quel moment dans le futur, par rapport à sa date de création, la sauvegarde doit être supprimée (par exemple, conserver les sauvegardes pendant sept jours).

DailyRecurrence

Pour une programmation qui s'exécute quotidiennement.

WeeklyRecurrence

Pour une programmation qui s'exécute chaque semaine un jour spécifique.

string

Obligatoire. La base de données parente.

Formater projects/{project}/databases/{database}

BackupSchedule

Obligatoire. Planification des sauvegardes à créer.

string

Obligatoire. Un nom parent au format projects/{project_id}

Database

Obligatoire. Base de données à créer.

string

Obligatoire. 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 /[a-z][0-9]-/. Le premier caractère est 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'ID de base de données "(par défaut)" est également valide.

string

Obligatoire. Un nom parent au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Index

Obligatoire. Index composite à créer.

string

Nom de ressource de la base de données. Format : projects/{project}/databases/{database}

string

Uniquement en sortie. UUID4 généré par le système pour cette base de données.

Timestamp

Uniquement en sortie. Horodatage de la création de cette base de données. Les bases de données créées avant 2016 ne renseignent pas create_time.

Timestamp

Uniquement en sortie. Horodatage de la dernière mise à jour de cette base de données. Notez que cela n'inclut que les mises à jour de la ressource de base de données, et non les données contenues dans la base de données.

string

Emplacement de la base de données. La liste des emplacements disponibles est indiquée à l'adresse https://cloud.google.com/firestore/docs/locations.

DatabaseType

Type de base de données. Consultez https://cloud.google.com/datastore/docs/firestore-or-datastore pour savoir comment faire votre choix.

ConcurrencyMode

Mode de contrôle de simultanéité à utiliser pour cette base de données.

Duration

Uniquement en sortie. Période pendant laquelle les versions antérieures des données sont conservées dans la base de données.

Tout read ou query peut spécifier un read_time dans cette fenêtre et lirea l'état de la base de données à ce moment-là.

Si la fonctionnalité PITR est activée, la période de conservation est de sept jours. Sinon, la durée de conservation est d'une heure.

Timestamp

Uniquement en sortie. 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 now - version_retention_period.

Cette valeur est mise à jour en continu et devient obsolète au moment de la requête. Si vous utilisez cette valeur pour récupérer des données, veillez à tenir compte du moment où la valeur est interrogée jusqu'au moment où vous lancez la récupération.

PointInTimeRecoveryEnablement

Activer ou non la fonctionnalité PITR sur cette base de données.

AppEngineIntegrationMode

Mode d'intégration App Engine à utiliser pour cette base de données.

string

Uniquement en sortie. Préfixe de clé pour cette base de données. Combinez ce préfixe key_prefix à l'ID de projet ("~") pour construire l'ID application renvoyé par les API Cloud Datastore dans les environnements d'exécution de première génération Google App Engine.

Cette valeur peut être vide, auquel cas l'identifiant de l'application à utiliser pour les clés encodées au format URL est le project_id (par exemple, foo au lieu de v~foo).

DeleteProtectionState

État de la protection contre la suppression pour la base de données.

string

Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de poursuivre.

string

Obligatoire. Nom de la sauvegarde à supprimer.

le format est projects/{project}/locations/{location}/backups/{backup}.

string

Obligatoire. Nom du planning des sauvegardes.

Formater projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Obligatoire. Un nom au format projects/{project_id}/databases/{database_id}

string

Etag actuel 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 s'affichera.

string

Obligatoire. Un nom au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Heure de début de l'opération.

Timestamp

Heure à laquelle cette opération s'est terminée. Ne sera pas défini si une opération est toujours en cours.

OperationState

État de l'opération d'exportation.

Progress

La progression, dans les documents, de cette opération.

Progress

Progression, en octets, de cette opération.

string

ID de collection en cours d'exportation.

string

Emplacement de l'exportation des documents.

string

ID d'espace de noms en cours d'exportation.

Timestamp

Code temporel correspondant à la version de la base de données en cours d'exportation. Si aucune valeur n'est spécifiée, aucune garantie n'est fournie concernant la cohérence des documents exportés.

string

Obligatoire. Base de données à exporter. Doit être au format suivant: projects/{project_id}/databases/{database_id}.

string

ID de collection à exporter. "Non spécifié" signifie que toutes les collections.

string

URI de sortie. Actuellement, seuls les URI Google Cloud Storage au format suivant sont acceptés: gs://BUCKET_NAME[/NAMESPACE_PATH], où BUCKET_NAME est le nom du bucket Google Cloud Storage et NAMESPACE_PATH est un chemin d'accès facultatif à l'espace de noms Google Cloud Storage. Lorsque vous choisissez un nom, tenez compte des consignes de dénomination de Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Si l'URI est un bucket (sans chemin d'espace de noms), un préfixe est généré en fonction de l'heure de début.

string

Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation privilégié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. Utilisez ce paramètre 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.

Timestamp

Code temporel correspondant à la version de la base de données à exporter. Le code temporel doit être dans le passé, arrondi à la minute et ne doit pas être antérieur à earliestVersionTime. Si cette option est spécifiée, les documents exportés représenteront une vue cohérente de la base de données au moment indiqué. Sinon, la cohérence des documents exportés n'est pas garantie.

string

Emplacement des fichiers de sortie. Vous pouvez l'utiliser pour lancer une importation dans Cloud Firestore (ce projet ou un autre projet) une fois l'opération terminée.

string

Obligatoire. Un nom de champ au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Un chemin d'accès de champ peut être un simple nom de champ, par exemple address , ou un chemin d'accès à des champs dans map_value (par exemple, address.city) ou un chemin d'accès de champ spécial. Le seul champ spécial valide est *, qui représente n'importe quel champ.

Les chemins d'accès des champs peuvent être indiqués à l'aide de (backtick). The only character that needs to 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),[,]`, ainsi que de n'importe quel caractère symbolique ASCII.

Exemples: (Remarque: Les commentaires sont rédigés dans la syntaxe markdown, ce qui implique qu'un bloc de code représente une couche supplémentaire d'accents graves.) \address.city`represents a field namedaddress.city, not the map key villein the fieldadresse. `*`represents a field named*`, et non un champ.

Un Field spécial contient les paramètres d'indexation par défaut de tous les champs. Le nom de ressource de ce champ est projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*. Les index définis sur ce Field seront appliqués à tous les champs qui ne possèdent pas leur propre configuration d'index Field.

IndexConfig

Configuration d'index pour ce champ. Si cette valeur n'est pas définie, l'indexation des champs reprend la configuration définie par ancestor_field. Pour supprimer explicitement tous les index de ce champ, spécifiez une configuration d'index avec une liste d'index vide.

TtlConfig

Configuration TTL pour ce Field. Si vous définissez ou désactivez cette option, la valeur TTL sera activée ou désactivée pour les documents associés à cette Field.

Index

Index compatibles avec ce champ.

bool

Uniquement en sortie. Lorsque la valeur est "true", la configuration de l'index de Field est définie à partir de la configuration spécifiée par ancestor_field. Lorsque la valeur est "false", la configuration d'index de Field est définie explicitement.

string

Uniquement en sortie. Spécifie le nom de la ressource Field à partir de laquelle la configuration d'index de ce champ est définie (lorsque uses_ancestor_config est défini sur "true") ou à partir de laquelle il serait défini si ce champ n'avait pas de configuration d'index (lorsque uses_ancestor_config est défini sur "false").

bool

Résultat uniquement. Si la valeur est "true", la configuration de l'index de Field est en cours de rétablissement. Une fois l'opération terminée, la configuration d'index passera au même état que le champ spécifié par ancestor_field, où uses_ancestor_config sera true et reverting sera false.

State

Uniquement en sortie. État de la configuration de la valeur TTL.

Timestamp

Heure de début de l'opération.

Timestamp

Heure à laquelle cette opération s'est terminée. Ne sera pas défini si une opération est toujours en cours.

string

Ressource de champ sur laquelle cette opération agit. Par exemple : projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

IndexConfigDelta

Liste de IndexConfigDelta, qui décrivent le but de cette opération.

OperationState

État de l'opération.

Progress

La progression, dans les documents, de cette opération.

Progress

Progression, en octets, de cette opération.

TtlConfigDelta

Décrit les deltas de la configuration TTL.

ChangeType

Spécifie la modification de l'index.

Index

Index en cours de modification.

ChangeType

Spécifie les modifications apportées à la configuration TTL.

string

Obligatoire. Nom de la sauvegarde à récupérer.

Format : projects/{project}/locations/{location}/backups/{backup}

string

Obligatoire. Nom du planning des sauvegardes.

Formater projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Obligatoire. Un nom au format projects/{project_id}/databases/{database_id}

string

Obligatoire. Un nom au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string

Obligatoire. Un nom au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Heure de début de l'opération.

Timestamp

Heure à laquelle cette opération s'est terminée. Ne sera pas défini si une opération est toujours en cours.

OperationState

État de l'opération d'importation.

Progress

La progression, dans les documents, de cette opération.

Progress

Progression, en octets, de cette opération.

string

ID de collection en cours d'importation.

string

Emplacement des documents importés.

string

ID d'espace de noms en cours d'importation.

string

Obligatoire. Base de données dans laquelle importer les données. Doit être au format suivant: projects/{project_id}/databases/{database_id}.

string

ID de collection à importer. "Non spécifié" signifie que toutes les collections incluses dans l'importation.

string

Emplacement des fichiers exportés. Il doit correspondre au préfixe output_uri_prefix d'une réponse ExportDocumentsResponse à partir d'une exportation qui s'est terminée avec succès. Consultez google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string

Une liste vide représente tous les espaces de noms. Il s'agit de l'utilisation privilégié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. Utilisez ce paramètre 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.

string

Uniquement en sortie. Nom défini par le serveur pour cet index. Ce nom pour les index composites prendra la forme suivante: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Pour les index à champ unique, ce champ sera vide.

QueryScope

Les index dont le champ d'application de requête de collection est spécifié autorisent les requêtes sur une collection enfant d'un document spécifique, spécifié au moment de la requête, et possédant le même ID de collection.

Les index dont le champ d'application de requête de groupe de collections est spécifié autorisent les requêtes sur toutes les collections descendant d'un document spécifique, spécifié au moment de la requête et ayant le même ID de collection que cet index.

ApiScope

Champ d'application d'API accepté par cet index.

IndexField

Champs acceptés 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 correspond toujours au chemin d'accès du champ __name__. Si, lors de la création, __name__ n'a pas été spécifié comme dernier champ, il sera ajouté automatiquement dans la même direction que celle du dernier champ défini. Si le dernier champ d'un index composite n'est pas directionnel, __name__ sera classé par ordre croissant dans l'ordre décroissant (sauf indication contraire explicite).

Pour les index à champ unique, il s'agira toujours d'une seule entrée dont le chemin d'accès de champ correspond à celui du champ associé.

State

Uniquement en sortie. État de diffusion de l'index.

string

Il peut s'agir de name. Pour les index à champ unique, il doit correspondre au nom du champ ou peut être omis.

Order

Indique que ce champ permet de trier par ordre spécifié ou de comparer en utilisant =, !=, <, <=, >, >=.

ArrayConfig

Indique que ce champ accepte les opérations sur les array_value.

VectorConfig

Indique que ce champ accepte les opérations de voisinage le plus proche et de distance sur le vecteur.

int32

Obligatoire. Dimension vectorielle à laquelle cette configuration s'applique.

L'index obtenu n'inclura que les vecteurs de cette dimension et peut être utilisé pour la recherche vectorielle avec la même dimension.

FlatIndex

Indique que l'index vectoriel est un index plat.

Timestamp

Heure de début de l'opération.

Timestamp

Heure à laquelle cette opération s'est terminée. Ne sera pas défini si une opération est toujours en cours.

string

Ressource d'index sur laquelle cette opération agit. Par exemple : projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

OperationState

État de l'opération.

Progress

La progression, dans les documents, de cette opération.

Progress

Progression, en octets, de cette opération.

string

Obligatoire. La base de données parente.

Format : projects/{project}/databases/{database}

BackupSchedule

Liste de toutes les planifications de sauvegarde.

string

Obligatoire. Emplacement à partir duquel répertorier les sauvegardes.

Format : projects/{project}/locations/{location} Utilisez {location} = '-' pour répertorier les sauvegardes de tous les emplacements pour le projet donné. Cela permet de répertorier les sauvegardes d'un seul emplacement ou de tous les emplacements.

Backup

Liste de toutes les sauvegardes du projet.

string

Liste des emplacements à partir desquels les sauvegardes existantes n'ont pas pu être récupérées.

Au lieu d'échouer l'intégralité des requêtes lorsqu'un seul établissement est inaccessible, cette réponse renvoie un ensemble de résultats partiel et une liste des emplacements impossibles à atteindre ici. La requête peut être relancée sur un seul emplacement pour obtenir une erreur concrète.

string

Obligatoire. Un nom parent au format projects/{project_id}

Database

Bases de données du projet.

string

Si les données concernant des bases de données individuelles ne peuvent pas être répertoriées, elles seront enregistrées ici.

Voici un exemple d'entrée: projects/some_project/locations/some_location. Cela peut se produire si la région cloud dans laquelle réside la base de données est actuellement indisponible. Dans ce cas, nous ne pouvons pas récupérer tous les détails de la base de données. Vous pourrez peut-être obtenir un message d'erreur plus détaillé (ou récupérer la ressource) en envoyant une requête "Get" pour la ressource ou une requête "List" pour l'emplacement spécifique.

string

Obligatoire. Un nom parent au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

Filtre à appliquer pour afficher les résultats de la liste. Actuellement, FirestoreAdmin.ListFields ne permet de répertorier que les champs qui ont été explicitement remplacés. Pour émettre cette requête, appelez FirestoreAdmin.ListFields avec un filtre qui inclut indexConfig.usesAncestorConfig:false .

int32

Nombre de résultats à renvoyer.

string

Jeton de page, renvoyé par un appel précédent à FirestoreAdmin.ListFields, qui peut être utilisé pour obtenir la page de résultats suivante.

Field

Champs demandés.

string

Jeton de page pouvant être utilisé pour demander une autre page de résultats. Si ce champ est vide, il s'agit de la dernière page.

string

Obligatoire. Un nom parent au format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

Filtre à appliquer pour afficher les résultats de la liste.

int32

Nombre de résultats à renvoyer.

string

Jeton de page, renvoyé par un appel précédent à FirestoreAdmin.ListIndexes, qui peut être utilisé pour obtenir la page de résultats suivante.

Index

Index demandés.

string

Jeton de page pouvant être utilisé pour demander une autre page de résultats. Si ce champ est vide, il s'agit de la dernière page.

int64

La quantité de travail estimée.

int64

La quantité de travail accomplie.

Timestamp

Heure à laquelle la restauration a commencé.

Timestamp

Heure à laquelle la restauration s'est terminée (non définie pour les restaurations en cours).

OperationState

État de l'opération de la restauration.

string

Nom de la base de données sur laquelle vous souhaitez effectuer la restauration.

string

Nom de la sauvegarde à partir de laquelle effectuer la restauration.

Progress

Avancement de la restauration, sous la forme d'un pourcentage estimé du temps restant.

string

Obligatoire. Projet dans lequel restaurer la base de données. Format : projects/{project_id}

string

Obligatoire. 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 comporter entre 4 et 63 caractères. Les caractères valides sont /[a-z][0-9]-/. Le premier caractère est 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'ID de base de données "(par défaut)" est également valide.

string

Sauvegarde à partir de laquelle effectuer la restauration. Doit appartenir au même projet que le parent.

Format : projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

Obligatoire. Planification des sauvegardes à mettre à jour.

FieldMask

Liste des champs à mettre à jour.

Database

Obligatoire. Base de données à mettre à jour.

FieldMask

Liste des champs à mettre à jour.

Field

Obligatoire. Champ à mettre à jour.

FieldMask

Un masque relatif au champ. Si elle est spécifiée, seule la configuration spécifiée par ce champ field_mask sera mise à jour dans le champ.

DayOfWeek

Jour de la semaine de diffusion.

DAY_OF_WEEK_UNSPECIFIED n'est pas autorisé.