Cette page a été traduite par l'API Cloud Translation.

Package google.firestore.admin.v1beta1

Index

FirestoreAdmin (interface)
CreateIndexRequest (message)
DeleteIndexRequest (message)
ExportDocumentsMetadata (message)
ExportDocumentsRequest (message)
ExportDocumentsResponse (message)
GetIndexRequest (message)
ImportDocumentsMetadata (message)
ImportDocumentsRequest (message)
Index (message)
Index.State (enum)
IndexField (message)
IndexField.Mode (enum)
IndexOperationMetadata (message)
IndexOperationMetadata.OperationType (enum)
ListIndexesRequest (message)
ListIndexesResponse (message)
LocationMetadata (message)
OperationState (enum)
Progress (message)

FirestoreAdmin

L'API Cloud Firestore Admin

Cette API fournit plusieurs services d'administration pour Cloud Firestore.

Concepts

Les éléments Projet, Base de données, Espace de noms, Collection et Document sont utilisés tel que défini dans l'API Google Cloud Firestore.

Opération: une opération représente une tâche qui s'exécute en arrière-plan.

Services

Index

Le service d'index gère les index Cloud Firestore.

La création de l'index s'effectue de manière asynchrone. Une ressource Operation est créée pour chaque opération asynchrone. L'état de l'opération (y compris toute erreur rencontrée) peut être interrogé via la ressource Operation.

Métadonnées

Fournit des métadonnées et des informations statistiques sur les données dans Cloud Firestore. Les données fournies dans le cadre de cette API sont peut-être obsolètes.

Opération

La collection Opérations fournit un enregistrement des actions effectuées pour le Projet spécifié (y compris toutes 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 qui n'est pas encore terminée peut être annulée. La demande d'annulation est asynchrone, et l'opération peut continuer à s'exécuter pendant un certain temps après l'envoi de la demande d'annulation.

Une opération terminée peut être supprimée pour qu'elle ne soit plus répertoriée dans la collection "Opération".

Les opérations sont créées par le service FirestoreAdmin, mais sont accessibles via le service google.longrunning.Operations.

CreateIndex

CreateIndex
`rpc CreateIndex(CreateIndexRequest) returns (Operation)` Crée l'index spécifié. L'état initial d'un index nouvellement créé est `CREATING`. Une fois l'`google.longrunning.Operation` renvoyée, l'état est `READY`. Si l'index existe déjà, l'appel renvoie l'état `ALREADY_EXISTS`. Lors de la création, le processus peut entraîner une erreur, auquel cas l'index passe à l'état `ERROR`. Vous pouvez récupérer le processus en corrigeant les données à l'origine de l'erreur, en supprimant l'index avec `delete`, puis en le recréant avec `create`. Impossible de créer des index ne comportant qu'un seul champ. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Crée l'index spécifié. L'état initial d'un index nouvellement créé est CREATING. Une fois l'google.longrunning.Operation renvoyée, l'état est READY. Si l'index existe déjà, l'appel renvoie l'état ALREADY_EXISTS.

Lors de la création, le processus peut entraîner une erreur, auquel cas l'index passe à l'état ERROR. Vous pouvez récupérer le processus en corrigeant les données à l'origine de l'erreur, en supprimant l'index avec delete, puis en le recréant avec create.

Impossible de créer des index ne comportant qu'un seul champ.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

DeleteIndex

DeleteIndex
`rpc DeleteIndex(DeleteIndexRequest) returns (Empty)` Supprime un index. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Supprime un index.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

ExportDocuments

ExportDocuments
`rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)` Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage. Il est possible que les modifications récentes apportées aux documents ne soient pas 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 "Operation" créée. Le résultat d'une exportation ne peut être utilisé qu'une fois l'opération associée terminée. Si une opération d'exportation est annulée avant qu'elle ne soit terminée, des données partielles peuvent être laissées dans Google Cloud Storage. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage. Il est possible que les modifications récentes apportées aux documents ne soient pas 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 "Operation" créée. Le résultat d'une exportation ne peut être utilisé qu'une fois l'opération associée terminée. Si une opération d'exportation est annulée avant qu'elle ne soit terminée, des données partielles peuvent être laissées dans Google Cloud Storage.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

GetIndex

GetIndex
`rpc GetIndex(GetIndexRequest) returns (Index)` Récupère un indice. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc GetIndex(GetIndexRequest) returns (Index)

Récupère un indice.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

ImportDocuments

ImportDocuments
`rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)` 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. Sa progression peut être surveillée et gérée via la ressource "Operation" créée. Si une opération ImportDocuments est annulée, il est possible qu'un sous-ensemble des données ait déjà été importé dans Cloud Firestore. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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. Sa progression peut être surveillée et gérée via la ressource "Operation" créée. Si une opération ImportDocuments est annulée, il est possible qu'un sous-ensemble des données ait déjà été importé dans Cloud Firestore.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

ListIndexes

ListIndexes
`rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)` Répertorie les index correspondant aux filtres spécifiés. Champs d'application des autorisations Nécessite l'un des champs d'application OAuth suivants : `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Pour en savoir plus, consultez la page Présentation de l'authentification.

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Répertorie les index correspondant aux filtres spécifiés.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

CreateIndexRequest

Requête pour FirestoreAdmin.CreateIndex.

Champs

Champs
`parent`	`string` Nom de la base de données à laquelle cet index s'appliquera. Par exemple : `projects/{project_id}/databases/{database_id}`
`index`	`Index` Index à créer. Les champs "name" (nom) et "state" (État) sont affichés en sortie uniquement et seront ignorés. Certains index à champ unique ne peuvent pas être créés ni supprimés.

parent

string

Nom de la base de données à laquelle cet index s'appliquera. Par exemple : projects/{project_id}/databases/{database_id}

index

Index

Index à créer. Les champs "name" (nom) et "state" (État) sont affichés en sortie uniquement et seront ignorés. Certains index à champ unique ne peuvent pas être créés ni supprimés.

DeleteIndexRequest

Requête pour FirestoreAdmin.DeleteIndex.

Champs

Champs
`name`	`string` Nom de l'index. Par exemple : `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

Nom de l'index. Par exemple : projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Métadonnées pour les opérations ExportDocuments.

Champs
`start_time`	`Timestamp` Heure à laquelle le travail a commencé sur l'opération.
`end_time`	`Timestamp` Heure à laquelle l'opération s'est terminée, qu'elle ait abouti ou non. Non défini si l'opération est toujours active.
`operation_state`	`OperationState` État de l'opération d'exportation.
`progress_documents`	`Progress` Estimation du nombre de documents traités.
`progress_bytes`	`Progress` Estimation du nombre d'octets traités.
`collection_ids[]`	`string` ID de collection en cours d'exportation.
`output_uri_prefix`	`string` Emplacement de l'exportation des entités.

ExportDocumentsRequest

Requête pour FirestoreAdmin.ExportDocuments.

Champs

Champs
`name`	`string` Base de données à exporter. Doit être au format suivant: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` ID de collection à exporter. "Non spécifié" signifie que toutes les collections.
`output_uri_prefix`	`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.

name

string

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

collection_ids[]

string

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

output_uri_prefix

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.

ExportDocumentsResponse

Renvoyé dans le champ de réponse google.longrunning.Operation.

Champs

Champs
`output_uri_prefix`	`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.

output_uri_prefix

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.

GetIndexRequest

Requête pour FirestoreAdmin.GetIndex.

Champs

Champs
`name`	`string` Nom de l'index. Par exemple : `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

Nom de l'index. Par exemple : projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Métadonnées pour les opérations ImportDocuments.

Champs
`start_time`	`Timestamp` Heure à laquelle le travail a commencé sur l'opération.
`end_time`	`Timestamp` Heure à laquelle l'opération s'est terminée, qu'elle ait abouti ou non. Non défini si l'opération est toujours active.
`operation_state`	`OperationState` État de l'opération d'importation.
`progress_documents`	`Progress` Estimation du nombre de documents traités.
`progress_bytes`	`Progress` Estimation du nombre d'octets traités.
`collection_ids[]`	`string` ID de collection en cours d'importation.
`input_uri_prefix`	`string` Emplacement des documents importés.

ImportDocumentsRequest

Requête pour FirestoreAdmin.ImportDocuments.

Champs

Champs
`name`	`string` Base de données dans laquelle importer les données. Doit être au format suivant: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` ID de collection à importer. "Non spécifié" signifie que toutes les collections incluses dans l'importation.
`input_uri_prefix`	`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.v1beta1.ExportDocumentsResponse.output_uri_prefix`.

name

string

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

collection_ids[]

string

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

input_uri_prefix

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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Index

Définition d'un index.

Champs
`name`	`string` Nom de ressource de l'index. Uniquement en sortie.
`collection_id`	`string` ID de collection auquel cet index s'applique. Obligatoire.
`fields[]`	`IndexField` Champs à indexer.
`state`	`State` État de l'index. Uniquement en sortie.

État

État d'un index. Lors de la création d'un index, son état est CREATING. Si l'index a bien été créé, il passe à l'état READY. Si l'index ne peut pas être créé, il passe à l'état ERROR.

Enums
`STATE_UNSPECIFIED`	L'état n'est pas spécifié.
`CREATING`	L'index est en cours de création. Une opération de longue durée est active pour l'index. L'index est mis à jour lors de l'écriture 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 l'écriture d'un document. L'index est entièrement renseigné à partir de tous les documents stockés auxquels il s'applique.
`ERROR`	L'index était en cours de création, mais un problème est survenu. Il n'existe pas d'opération de longue durée active pour l'index, et la dernière opération de longue durée 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.

IndexField

Champ d'un index.

Champs

Champs
`field_path`	`string` Chemin d'accès du champ. Doit correspondre à la spécification du chemin d'accès du champ décrite par [google.firestore.v1beta1.Document.fields][fields]. Le chemin d'accès de champ spécial `__name__` peut être utilisé seul ou à la fin d'un chemin. `__type__` ne peut être utilisé qu'à la fin du chemin.
`mode`	`Mode` Mode du champ.

field_path

string

Chemin d'accès du champ. Doit correspondre à la spécification du chemin d'accès du champ décrite par [google.firestore.v1beta1.Document.fields][fields]. Le chemin d'accès de champ spécial __name__ peut être utilisé seul ou à la fin d'un chemin. __type__ ne peut être utilisé qu'à la fin du chemin.

mode

Mode

Mode du champ.

Mode

Le mode détermine la manière dont un champ est indexé.

Enums
`MODE_UNSPECIFIED`	Le mode n'est pas spécifié.
`ASCENDING`	Les valeurs du champ sont indexées de manière à permettre le séquençage dans l'ordre croissant et à être interrogées avec les caractères <, >, <=, >= et =.
`DESCENDING`	Les valeurs du champ sont indexées de manière à permettre le séquençage par ordre décroissant et également à interroger les données en fonction des caractères <, >, <=, >= et =.
`ARRAY_CONTAINS`	Les valeurs de tableau du champ sont indexées de manière à permettre l'appartenance à l'aide de requêtes ARRAY_CONTAINS.

IndexOperationMetadata

Métadonnées pour les opérations d'index. Ces métadonnées renseignent le champ de métadonnées de google.longrunning.Operation.

Champs
`start_time`	`Timestamp` Heure à laquelle le travail a commencé sur l'opération.
`end_time`	`Timestamp` Heure à laquelle l'opération s'est terminée, qu'elle ait abouti ou non. Non défini si l'opération est toujours active.
`index`	`string` Ressource d'index sur laquelle cette opération agit. Par exemple : `projects/{project_id}/databases/{database_id}/indexes/{index_id}`
`operation_type`	`OperationType` Type d'opération d'index.
`cancelled`	`bool` "True" si `google.longrunning.Operation` a été annulé. Si l'annulation est en cours, la valeur "cancel" sera définie sur "true", mais `google.longrunning.Operation.done` sera définie sur "false".
`document_progress`	`Progress` Progression de l'opération existante, mesurée en nombre de documents.

OperationType

Type d'opération d'index.

Enums
`OPERATION_TYPE_UNSPECIFIED`	URL indéterminée. Jamais défini par le serveur.
`CREATING_INDEX`	L'opération crée l'index. Déclenchement par un appel `CreateIndex`.

ListIndexesRequest

Requête pour FirestoreAdmin.ListIndexes.

Champs
`parent`	`string` Nom de la base de données. Par exemple : `projects/{project_id}/databases/{database_id}`
`filter`	`string`
`page_size`	`int32` La taille de page de la liste standard.
`page_token`	`string` Jeton de page de liste standard.

ListIndexesResponse

Réponse pour FirestoreAdmin.ListIndexes.

Champs

Champs
`indexes[]`	`Index` Les index.
`next_page_token`	`string` Le jeton de page suivante de la liste standard.

indexes[]

Index

Les index.

next_page_token

string

Le jeton de page suivante de la liste standard.

LocationMetadata

Ce type ne comporte aucun champ.

Message de métadonnées pour google.cloud.location.Location.metadata.

OperationState

Les différents états possibles d'une opération en cours.

Enums
`STATE_UNSPECIFIED`	URL indéterminée.
`INITIALIZING`	La requête est en cours de préparation pour le traitement.
`PROCESSING`	Requête en cours de traitement.
`CANCELLING`	La requête est en cours d'annulation après que l'utilisateur a appelé google.longrunning.Operations.CancelOperation lors de l'opération.
`FINALIZING`	La demande a été traitée et est en phase de finalisation.
`SUCCESSFUL`	La demande a bien été traitée.
`FAILED`	Le traitement de la demande est terminé, mais une erreur s'est produite.
`CANCELLED`	L'annulation de la requête est terminée après que l'utilisateur a appelé google.longrunning.Operations.CancelOperation.

Progression

Mesure la progression d'une métrique donnée.

Champs

Champs
`work_completed`	`int64` Une estimation de la quantité de travail accomplie. Notez que cette valeur peut être supérieure à `work_estimated`.
`work_estimated`	`int64` Estimation de la quantité de travail nécessaire. Zéro si l'estimation du travail n'est pas disponible. Elle est susceptible d'évoluer au fur et à mesure de l'avancement des travaux.

work_completed

int64

Une estimation de la quantité de travail accomplie. Notez que cette valeur peut être supérieure à work_estimated.

work_estimated

int64

Estimation de la quantité de travail nécessaire. Zéro si l'estimation du travail n'est pas disponible. Elle est susceptible d'évoluer au fur et à mesure de l'avancement des travaux.