Package google.firestore.admin.v1beta1

Indice

FirestoreAdmin

L'API Cloud Firestore Admin.

Questa API fornisce diversi servizi amministrativi per Cloud Firestore.

Concetti

Progetto, Database, Spazio dei nomi, Raccolta e Documento vengono utilizzati come definito nell'API Google Cloud Firestore.

Operazione: un'operazione rappresenta il lavoro eseguito in background.

Servizi

Indice

Il servizio di indicizzazione gestisce gli indici di Cloud Firestore.

La creazione dell'indice viene eseguita in modo asincrono. Per ogni operazione asincrona di questo tipo viene creata una risorsa dell'operazione. È possibile eseguire una query sullo stato dell'operazione (compresi eventuali errori riscontrati) tramite la risorsa dell'operazione.

Metadati

Fornisce metadati e informazioni statistiche sui dati in Cloud Firestore. I dati forniti come parte di questa API potrebbero essere obsoleti.

Operazione

La raccolta Operazioni fornisce un registro delle azioni eseguite per il progetto specificato (incluse le operazioni in corso). Le operazioni non vengono create direttamente, ma tramite chiamate su altre raccolte o risorse.

Un'operazione non ancora completata potrebbe essere annullata. La richiesta di annullamento è asincrona e l'operazione può continuare per un po' di tempo dopo che viene effettuata la richiesta di annullamento.

Un'operazione eseguita potrebbe essere eliminata in modo che non sia più elencata come parte della raccolta delle operazioni.

Le operazioni vengono create dal servizio FirestoreAdmin, ma sono accessibili tramite il servizio google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Crea l'indice specificato. Lo stato iniziale di un indice appena creato è CREATING. Al completamento dell'istruzione google.longrunning.Operation restituita, lo stato sarà READY. Se l'indice esiste già, la chiamata restituirà lo stato ALREADY_EXISTS.

Durante la creazione, il processo potrebbe generare un errore e in questo caso l'indice passerà allo stato ERROR. Il processo può essere recuperato correggendo i dati che hanno causato l'errore, rimuovendo l'indice con delete e ricreando l'indice con create.

Impossibile creare indici con un singolo campo.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Elimina un indice.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage. I recenti aggiornamenti ai documenti potrebbero non essere visualizzati nell'esportazione. L'esportazione avviene in background e il suo avanzamento può essere monitorato e gestito tramite la risorsa Operazione creata. L'output di un'esportazione può essere utilizzato solo al termine dell'operazione associata. Se un'operazione di esportazione viene annullata prima del completamento, potrebbe lasciare dei dati parziali in Google Cloud Storage.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Recupera un indice.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importa i documenti in Google Cloud Firestore. I documenti esistenti con lo stesso nome vengono sovrascritti. L'importazione avviene in background e il suo avanzamento può essere monitorato e gestito tramite la risorsa Operazione creata. Se un'operazione ImportDocumenti viene annullata, è possibile che un sottoinsieme di dati sia già stato importato in Cloud Firestore.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Elenca gli indici che corrispondono ai filtri specificati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

CreateIndexRequest

La richiesta di FirestoreAdmin.CreateIndex.

Campi
parent

string

Il nome del database a cui si applica questo indice. Ad esempio: projects/{project_id}/databases/{database_id}
index

Index

L'indice da creare. I campi del nome e dello stato sono solo di output e verranno ignorati. Alcuni indici a campo singolo non possono essere creati o eliminati.

DeleteIndexRequest

La richiesta di FirestoreAdmin.DeleteIndex.

Campi
name

string

Il nome dell'indice. Ad esempio: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadati per le operazioni ExportDocumenti.

Campi
start_time

Timestamp

L'ora in cui sono iniziati i lavori dell'operazione.
end_time

Timestamp

L'ora in cui l'operazione è terminata correttamente o meno. Non viene configurato se l'operazione è ancora attiva.
operation_state

OperationState

Lo stato dell'operazione di esportazione.
progress_documents

Progress

Una stima del numero di documenti elaborati.
progress_bytes

Progress

Una stima del numero di byte elaborati.
collection_ids[]

string

Quali ID raccolta vengono esportati.
output_uri_prefix

string

Località in cui vengono esportate le entità.

ExportDocumentsRequest

La richiesta di FirestoreAdmin.ExportDocuments.

Campi
name

string

Database da esportare. Deve essere nel formato: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Quali ID raccolta esportare. Non specificati indica tutte le raccolte.
output_uri_prefix

string

L'URI di output. Attualmente supporta solo gli URI Google Cloud Storage nel formato gs://BUCKET_NAME[/NAMESPACE_PATH], dove BUCKET_NAME è il nome del bucket Google Cloud Storage e NAMESPACE_PATH è un percorso facoltativo dello spazio dei nomi di Google Cloud Storage. Quando scegli un nome, assicurati di tenere in considerazione le linee guida di Google Cloud Storage per la denominazione: https://cloud.google.com/storage/docs/naming. Se l'URI è un bucket (senza un percorso dello spazio dei nomi), verrà generato un prefisso in base all'ora di inizio.

ExportDocumentsResponse

Restituito nel campo di risposta google.longrunning.Operation.

Campi
output_uri_prefix

string

Percorso dei file di output. Può essere utilizzato per avviare un'importazione in Cloud Firestore (questo o un altro progetto) dopo il corretto completamento dell'operazione.

GetIndexRequest

La richiesta di FirestoreAdmin.GetIndex.

Campi
name

string

Il nome dell'indice. Ad esempio: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadati per le operazioni ImportDocumenti.

Campi
start_time

Timestamp

L'ora in cui sono iniziati i lavori dell'operazione.
end_time

Timestamp

L'ora in cui l'operazione è terminata correttamente o meno. Non viene configurato se l'operazione è ancora attiva.
operation_state

OperationState

Lo stato dell'operazione di importazione.
progress_documents

Progress

Una stima del numero di documenti elaborati.
progress_bytes

Progress

Una stima del numero di byte elaborati.
collection_ids[]

string

Gli ID raccolta che vengono importati.
input_uri_prefix

string

La posizione dei documenti da importare.

ImportDocumentsRequest

La richiesta di FirestoreAdmin.ImportDocuments.

Campi
name

string

Database in cui eseguire l'importazione. Deve essere nel formato: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Quali ID raccolta importare. Non specificati indica tutte le raccolte incluse nell'importazione.
input_uri_prefix

string

Percorso dei file esportati. Deve corrispondere al prefisso output_uri_prefix di un valore ExportDocumentsResponse di un'esportazione completata correttamente. Vedi: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Indice

Una definizione di indice.

Campi
name

string

Il nome della risorsa dell'indice. Solo output.
collection_id

string

L'ID raccolta a cui si applica l'indice. Obbligatoria.
fields[]

IndexField

I campi da indicizzare.
state

State

Lo stato dell'indice. Solo output.

Stato

Lo stato di un indice. Durante la creazione dell'indice, un indice sarà nello stato CREATING. Se l'indice viene creato correttamente, passerà allo stato READY. Se non è possibile creare l'indice, passerà allo stato ERROR.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
CREATING L'indice è in fase di creazione. È presente un'operazione a lunga esecuzione attiva per l'indice. L'indice viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati dell'indice.
READY L'indice è pronto per essere utilizzato. L'indice viene aggiornato durante la scrittura di un documento. L'indice viene compilato completamente a partire da tutti i documenti archiviati a cui si applica.
ERROR L'indice è in fase di creazione, ma si è verificato un problema. Non esiste un'operazione a lunga esecuzione attiva per l'indice e l'ultima operazione a lunga esecuzione non è riuscita. L'indice non viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati dell'indice.

IndexField

Un campo di un indice.

Campi
field_path

string

Il percorso del campo. Deve corrispondere alla specifica del percorso di campo descritta in [google.firestore.v1beta1.Document.fields][fields]. Il percorso del campo speciale __name__ può essere utilizzato da solo o alla fine di un percorso. __type__ può essere utilizzato solo alla fine del percorso.
mode

Mode

La modalità del campo.

Modalità

La modalità determina il modo in cui un campo viene indicizzato.

Enum
MODE_UNSPECIFIED La modalità non è specificata.
ASCENDING I valori del campo sono indicizzati in modo da supportare la sequenza in ordine crescente e anche eseguire query per <, >, <=, >= e =.
DESCENDING I valori del campo sono indicizzati in modo da supportare la sequenza in ordine decrescente e anche eseguire query per <, >, <=, >= e =.
ARRAY_CONTAINS I valori array del campo sono indicizzati in modo da supportare l'appartenenza utilizzando le query ARRAY_CONTAINS.

IndexOperationMetadata

Metadati per le operazioni sull'indicizzazione. Questi metadati compilano il campo dei metadati di google.longrunning.Operation.

Campi
start_time

Timestamp

L'ora in cui sono iniziati i lavori dell'operazione.
end_time

Timestamp

L'ora in cui l'operazione è terminata correttamente o meno. Non viene configurato se l'operazione è ancora attiva.
index

string

La risorsa di indice su cui agisce questa operazione. Ad esempio: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

Il tipo di operazione sull'indice.
cancelled

bool

True se google.longrunning.Operation è stato annullato. Se l'annullamento è in corso, l'annullamento sarà vero, mentre google.longrunning.Operation.done sarà falso.
document_progress

Progress

Avanzamento dell'operazione esistente, misurato in numero di documenti.

OperationType

Il tipo di operazione sull'indice.

Enum
OPERATION_TYPE_UNSPECIFIED Non specificato. Mai impostata dal server.
CREATING_INDEX L'operazione sta creando l'indice. Avviato da una chiamata al numero CreateIndex.

ListIndexesRequest

La richiesta di FirestoreAdmin.ListIndexes.

Campi
parent

string

Il nome del database. Ad esempio: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Le dimensioni standard della pagina Elenco.
page_token

string

Il token della pagina Elenco standard.

ListIndexesResponse

La risposta per FirestoreAdmin.ListIndexes.

Campi
indexes[]

Index

Gli indici.
next_page_token

string

Il token standard della pagina successiva dell'elenco.

LocationMetadata

Questo tipo non contiene campi.

Il messaggio relativo ai metadati per google.cloud.location.Location.metadata.

OperationState

I vari stati possibili di un'operazione in corso.

Enum
STATE_UNSPECIFIED Non specificato.
INITIALIZING La richiesta è in fase di preparazione per l'elaborazione.
PROCESSING La richiesta è in fase di elaborazione.
CANCELLING La richiesta è in fase di annullamento dopo che l'utente ha chiamato google.longrunning.Operations.CancelOperation per l'operazione.
FINALIZING La richiesta è stata elaborata ed è in fase di finalizzazione.
SUCCESSFUL Richiesta completata.
FAILED La richiesta è in fase di elaborazione, ma si è verificato un errore.
CANCELLED L'annullamento della richiesta è terminato dopo che l'utente ha chiamato google.longrunning.Operations.CancelOperation.

Avanzamento

Misura l'avanzamento di una determinata metrica.

Campi
work_completed

int64

Una stima del lavoro completato. Tieni presente che potrebbe essere superiore a work_estimated.
work_estimated

int64

Una stima del lavoro da eseguire. Zero se la stima del lavoro non è disponibile. Può cambiare con l'avanzamento del lavoro.