Package google.firestore.admin.v1beta1

Indice

FirestoreAdmin

L'API di amministrazione di Cloud Firestore.

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 indice gestisce gli indici Cloud Firestore.

La creazione dell'indice viene eseguita in modo asincrono. Per ciascuna operazione asincrona viene creata una risorsa operazione. Lo stato dell'operazione (compresi eventuali errori riscontrati) può essere interrogato tramite la risorsa 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 eventuali Operazioni in corso). Le operazioni non vengono create direttamente ma tramite chiamate su altre raccolte o risorse.

Un'operazione non ancora completata può essere annullata. La richiesta di annullamento è asincrona e l'operazione può continuare a essere eseguita per un certo periodo di tempo dopo aver effettuato la richiesta di annullamento.

Un'operazione eseguita può essere eliminata in modo che non sia più elencata come parte della raccolta Operazioni.

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

CreaIndice

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

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

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

Non è possibile creare indici con un singolo campo.

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

Elimina indice

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

Elimina un indice.

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

Esporta documenti

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Esporta una copia di tutti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage. Gli aggiornamenti recenti ai documenti potrebbero non riflettersi 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 una volta completata l'operazione associata. Se un'operazione di esportazione viene annullata prima del completamento, potrebbe lasciare dati parziali in Google Cloud Storage.

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

OttieniIndice

rpc GetIndex( GetIndexRequest ) returns ( Index )

Ottiene un indice.

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

Importa documenti

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

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

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

ListIndex

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

Elenca gli indici che corrispondono ai filtri specificati.

Ambiti autorizzativi

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

Crea richiesta indice

La richiesta per FirestoreAdmin.CreateIndex .

Campi
parent

string

Il nome del database a cui verrà applicato questo indice. Ad esempio: projects/{project_id}/databases/{database_id}

index

Index

L'indice da creare. I campi nome e stato vengono solo emessi e verranno ignorati. Alcuni indici di campi singoli non possono essere creati o eliminati.

EliminaIndiceRichiesta

La richiesta per 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 ExportDocuments.

Campi
start_time

Timestamp

Il momento in cui sono iniziati i lavori sull'operazione.

end_time

Timestamp

L'ora in cui l'operazione è terminata, con esito positivo o negativo. Disimpostato 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 di raccolta vengono esportati.

output_uri_prefix

string

Dove vengono esportate le entità.

ExportDocumentsRequest

La richiesta per FirestoreAdmin.ExportDocuments .

Campi
name

string

Database da esportare. Dovrebbe essere nel formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Quali ID di raccolta esportare. Non specificato significa tutte le raccolte.

output_uri_prefix

string

L'URI di output. Attualmente supporta solo URI di 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 considerare le linee guida per la denominazione di Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Se l'URI è un bucket (senza 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

Posizione dei file di output. Questo può essere utilizzato per iniziare un'importazione in Cloud Firestore (questo progetto o un altro progetto) dopo che l'operazione è stata completata correttamente.

OttieniRichiestaIndice

La richiesta per 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 ImportDocuments.

Campi
start_time

Timestamp

Il momento in cui sono iniziati i lavori sull'operazione.

end_time

Timestamp

L'ora in cui l'operazione è terminata, con esito positivo o negativo. Disimpostato 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

Quali ID di raccolta vengono importati.

input_uri_prefix

string

La posizione dei documenti da importare.

ImportDocumentsRequest

La richiesta per FirestoreAdmin.ImportDocuments .

Campi
name

string

Database in cui importare. Dovrebbe essere nel formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Quali ID di raccolta importare. Non specificato significa tutte le raccolte incluse nell'importazione.

input_uri_prefix

string

Posizione dei file esportati. Deve corrispondere all'output_uri_prefix di un ExportDocumentsResponse da 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 uscita.

collection_id

string

L'ID della raccolta a cui si applica questo indice. Necessario.

fields[]

IndexField

I campi da indicizzare.

state

State

Lo stato dell'indice. Solo uscita.

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 .

Enumerazioni
STATE_UNSPECIFIED Lo stato non è specificato.
CREATING L'indice è in fase di creazione. È presente un'operazione attiva a lunga esecuzione per l'indice. L'indice viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati di indice.
READY L'indice è pronto per essere utilizzato. L'indice viene aggiornato durante la scrittura di un documento. L'indice è completamente popolato da tutti i documenti archiviati a cui si applica.
ERROR L'indice era in fase di creazione, ma qualcosa è andato storto. Non sono presenti operazioni a esecuzione prolungata attive per l'indice e l'operazione a esecuzione prolungata completata più recentemente non è riuscita. L'indice non viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati di indice.

Campo Indice

Un campo di un indice.

Campi
field_path

string

Il percorso del campo. Deve corrispondere alla specifica del percorso del campo descritta da [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 viene indicizzato un campo.

Enumerazioni
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 discendente e anche eseguire query per <, >, <=, >= e =.
ARRAY_CONTAINS I valori dell'array del campo sono indicizzati in modo da supportare l'appartenenza utilizzando le query ARRAY_CONTAINS.

IndexOperationMetadata

Metadati per le operazioni sugli indici. Questi metadati popolano il campo dei metadati di google.longrunning.Operation .

Campi
start_time

Timestamp

Il momento in cui sono iniziati i lavori sull'operazione.

end_time

Timestamp

L'ora in cui l'operazione è terminata, con esito positivo o negativo. Disimpostato se l'operazione è ancora attiva.

index

string

La risorsa 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

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

document_progress

Progress

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

TipoOperazione

Il tipo di operazione sull'indice.

Enumerazioni
OPERATION_TYPE_UNSPECIFIED Non specificato. Mai impostato dal server.
CREATING_INDEX L'operazione sta creando l'indice. Avviato da una chiamata CreateIndex .

ListIndexRequest

La richiesta per 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.

ElencoIndiciRisposta

La risposta per FirestoreAdmin.ListIndexes .

Campi
indexes[]

Index

Gli indici.

next_page_token

string

Il token standard della pagina successiva dell'elenco.

Metadati di posizione

Questo tipo non ha campi.

Il messaggio di metadati per google.cloud.location.Location.metadata .

StatoOperazione

I vari stati possibili per un'Operazione in corso.

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

Progresso

Misura l'avanzamento di una particolare metrica.

Campi
work_completed

int64

Una stima della quantità di lavoro completata. Tieni presente che questo potrebbe essere maggiore di work_estimated .

work_estimated

int64

Una stima della quantità di lavoro da eseguire. Zero se la stima del lavoro non è disponibile. Potrebbe cambiare con l'avanzamento dei lavori.