Package google.firestore.admin.v1beta2

Index

FirestoreAdmin

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Crée un index composite. Cela renvoie un google.longrunning.Operation qui peut être utilisé pour suivre l'état de la création. Les métadonnées de l'opération sont de type IndexOperationMetadata.

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

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Supprime un index composite.

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

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.
GetField

rpc GetField(GetFieldRequest) returns (Field)

Récupère les métadonnées et la configuration d'un 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.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Récupère un index composite.

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

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.
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Répertorie la configuration et les métadonnées des champs pour cette base de données.

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 le filtre défini sur indexConfig.usesAncestorConfig:false.

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Répertorie les index composites.

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.
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Met à jour une configuration de champ. Actuellement, les mises à jour de champs ne s'appliquent qu'à la configuration d'index à champ unique. Toutefois, les appels à FirestoreAdmin.UpdateField doivent fournir un masque de champ pour éviter de modifier une configuration dont l'appelant n'a pas connaissance. Le masque de champ doit être spécifié comme suit: { paths: "index_config" }.

Cet appel renvoie un google.longrunning.Operation qui peut être utilisé pour suivre l'état de la mise à jour du champ. Les métadonnées de l'opération sont de type FieldOperationMetadata.

Pour configurer les paramètres de champ par défaut de la base de données, utilisez le Field spécial avec le nom de ressource projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

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
parent

string

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

Index

Index composite à créer.

DeleteIndexRequest

Requête pour FirestoreAdmin.DeleteIndex.

Champs
name

string

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

ExportDocumentsMetadata

Métadonnées pour les résultats google.longrunning.Operation de FirestoreAdmin.ExportDocuments.

Champs
start_time

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

Progression, en octets, de cette opération.
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
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
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.

Champ

Représente un champ unique de la base de données.

Les champs sont regroupés en fonction de leur "groupe de collections", qui représente toutes les collections de la base de données ayant le même identifiant.

Champs
name

string

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.
index_config

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.

IndexConfig

Configuration d'index pour ce champ.

Champs
indexes[]

Index

Index compatibles avec ce champ.
uses_ancestor_config

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.
ancestor_field

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").
reverting

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.

FieldOperationMetadata

Métadonnées pour les résultats google.longrunning.Operation de FirestoreAdmin.UpdateField.

Champs
start_time

Timestamp

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

Timestamp

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

string

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

IndexConfigDelta

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

OperationState

État de l'opération.
document_progress

Progress

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

Progress

Progression, en octets, de cette opération.

IndexConfigDelta

Informations sur une modification de la configuration d'index.

Champs
change_type

ChangeType

Spécifie la modification de l'index.
index

Index

Index en cours de modification.

ChangeType

Spécifie la modification de l'index.

Enums
CHANGE_TYPE_UNSPECIFIED Le type de modification n'est ni spécifié, ni connu.
ADD L'index de champ unique est en cours d'ajout.
REMOVE L'index de champ unique est en cours de suppression.

GetFieldRequest

Requête pour FirestoreAdmin.GetField.

Champs
name

string

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

GetIndexRequest

Requête pour FirestoreAdmin.GetIndex.

Champs
name

string

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

ImportDocumentsMetadata

Métadonnées pour les résultats google.longrunning.Operation de FirestoreAdmin.ImportDocuments.

Champs
start_time

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

Progression, en octets, de cette opération.
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
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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Index

Les index Cloud Firestore permettent d'exécuter des requêtes simples et complexes sur les documents d'une base de données.

Champs
name

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.
query_scope

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.
fields[]

IndexField

Champs acceptés par cet index.

Pour les index composites, il s'agit toujours d'au moins deux 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

State

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

IndexField

Champ d'un index. Le champ "field_path" décrit le champ indexé, tandis que le champ "value_mode" décrit la manière dont la valeur du champ est indexée.

Champs
field_path

string

Il peut s'agir de name. Pour les index à champ unique, il doit correspondre au nom du champ ou peut être omis.
Champ d'union value_mode. Manière dont la valeur du champ est indexée. value_mode ne peut être qu'un des éléments suivants :
order

Order

Indique que ce champ permet de trier dans l'ordre spécifié ou de comparer en utilisant =, <, <=, >, >=.
array_config

ArrayConfig

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

ArrayConfig

Configurations de valeurs de tableau acceptées.

Enums
ARRAY_CONFIG_UNSPECIFIED L'index n'accepte pas d'autres requêtes de tableau.
CONTAINS L'index prend en charge les requêtes de confinement de tableau.

Commande

Ordres acceptés.

Enums
ORDER_UNSPECIFIED L'ordre n'est pas spécifié. Option non valide.
ASCENDING Le champ est trié par ordre croissant de valeur.
DESCENDING Le champ est trié par valeur de champ décroissante.

QueryScope

Le champ d'application de la requête définit le champ d'application auquel une requête est exécutée. Ceci est spécifié dans le champ from d'une requête structurée.

Enums
QUERY_SCOPE_UNSPECIFIED Le champ d'application de la requête n'est pas spécifié. Option non valide.
COLLECTION 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 dont l'ID de collection est spécifié par l'index.
COLLECTION_GROUP 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 possédant l'ID de collection spécifié par l'index.

É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 un problème survient lors de la création de l'index, l'index passe à l'état NEEDS_REPAIR.

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.
NEEDS_REPAIR 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. Utilisez l'API google.longrunning.Operations pour déterminer pourquoi la dernière tentative de création de cet index a échoué, puis recréez l'index.

IndexOperationMetadata

Métadonnées pour les résultats google.longrunning.Operation de FirestoreAdmin.CreateIndex.

Champs
start_time

Timestamp

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

Timestamp

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

string

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

OperationState

État de l'opération.
progress_documents

Progress

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

Progress

Progression, en octets, de cette opération.

ListFieldsRequest

Requête pour FirestoreAdmin.ListFields.

Champs
parent

string

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

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 le filtre défini sur indexConfig.usesAncestorConfig:false.
page_size

int32

Nombre de résultats à renvoyer.
page_token

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.

ListFieldsResponse

Réponse pour FirestoreAdmin.ListFields.

Champs
fields[]

Field

Champs demandés.
next_page_token

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.

ListIndexesRequest

Requête pour FirestoreAdmin.ListIndexes.

Champs
parent

string

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

string

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

int32

Nombre de résultats à renvoyer.
page_token

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.

ListIndexesResponse

Réponse pour FirestoreAdmin.ListIndexes.

Champs
indexes[]

Index

Index demandés.
next_page_token

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.

OperationState

Décrit l'état de l'opération.

Enums
OPERATION_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

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 est utilisé.

Champs
estimated_work

int64

La quantité de travail estimée.
completed_work

int64

La quantité de travail accomplie.

UpdateFieldRequest

Requête pour FirestoreAdmin.UpdateField.

Champs
field

Field

Champ à mettre à jour.
update_mask

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.