Package google.firestore.admin.v1beta2

Indice

FirestoreAdmin

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Crea un indice composto. Viene restituito un valore google.longrunning.Operation che può essere utilizzato per monitorare lo stato della creazione. I metadati per l'operazione saranno di tipo IndexOperationMetadata.

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

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

rpc GetField(GetFieldRequest) returns (Field)

Recupera i metadati e la configurazione di un 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.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Recupera un indice composto.

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

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Elenca la configurazione dei campi e i metadati per questo database.

Attualmente, FirestoreAdmin.ListFields supporta solo i campi dell'elenco di cui è stato eseguito l'override esplicito. Per eseguire questa query, chiama FirestoreAdmin.ListFields con il filtro impostato su indexConfig.usesAncestorConfig:false.

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

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

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Aggiorna la configurazione di un campo. Attualmente, gli aggiornamenti dei campi si applicano solo alla configurazione dell'indice a campo singolo. Tuttavia, le chiamate a FirestoreAdmin.UpdateField devono fornire una maschera di campo per evitare di modificare qualsiasi configurazione di cui il chiamante non è a conoscenza. La maschera del campo deve essere specificata come: { paths: "index_config" }.

Questa chiamata restituisce un google.longrunning.Operation che può essere utilizzato per monitorare lo stato dell'aggiornamento dei campi. I metadati per l'operazione saranno di tipo FieldOperationMetadata.

Per configurare le impostazioni predefinite dei campi per il database, utilizza lo speciale Field con nome risorsa: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

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

Un nome principale del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

L'indice composto da creare.

DeleteIndexRequest

La richiesta di FirestoreAdmin.DeleteIndex.

Campi
name

string

Un nome del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

I metadati per google.longrunning.Operation risultati da FirestoreAdmin.ExportDocuments.

Campi
start_time

Timestamp

L'ora di inizio dell'operazione.
end_time

Timestamp

L'ora del completamento dell'operazione. Il set di dati non verrà impostato se l'operazione è ancora in corso.
operation_state

OperationState

Lo stato dell'operazione di esportazione.
progress_documents

Progress

L'avanzamento, in documenti, di questa operazione.
progress_bytes

Progress

L'avanzamento, in byte, di questa operazione.
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.

Tecnico

Rappresenta un singolo campo nel database.

I campi vengono raggruppati in base al "Gruppo di raccolte", che rappresenta tutte le raccolte nel database con lo stesso ID.

Campi
name

string

Un nome di campo nel modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Un percorso di campo può essere un nome di campo semplice (ad es. address) o un percorso dei campi all'interno di map_value (ad es. address.city) oppure un percorso di campo speciale. L'unico campo speciale valido è *, che rappresenta qualsiasi campo.

I percorsi dei campi possono essere racchiusi tra virgolette utilizzando (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),[,]", nonché qualsiasi carattere simbolico ASCII.

Esempi: (nota: i commenti qui sono scritti con la sintassi di markdown, quindi è presente un ulteriore livello di apici inversi per rappresentare un blocco di codice) \address.city"represents a field namedaddress.city, not the map key cityin the fieldaddress. "*"represents a field named*", non un campo.

Un elemento Field speciale contiene le impostazioni di indicizzazione predefinite per tutti i campi. Il nome della risorsa di questo campo è: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Gli indici definiti in questo Field verranno applicati a tutti i campi che non hanno una propria configurazione degli indici Field.
index_config

IndexConfig

La configurazione dell'indice per questo campo. Se il criterio non viene configurato, l'indicizzazione dei campi tornerà alla configurazione definita da ancestor_field. Per rimuovere esplicitamente tutti gli indici per questo campo, specifica una configurazione degli indici con un elenco vuoto di indici.

IndexConfig

La configurazione dell'indice per questo campo.

Campi
indexes[]

Index

Gli indici supportati per questo campo.
uses_ancestor_config

bool

Solo output. Se il valore è true, la configurazione dell'indice di Field viene impostata in base alla configurazione specificata da ancestor_field. Se il valore è false, la configurazione dell'indice di Field viene definita in modo esplicito.
ancestor_field

string

Solo output. Specifica il nome della risorsa Field da cui viene impostata la configurazione dell'indice di questo campo (quando uses_ancestor_config è true) o da cui verrebbe impostato se il campo non aveva alcuna configurazione dell'indice (quando uses_ancestor_config è false).
reverting

bool

Output solo Se il valore è true, la configurazione dell'indice di Field è in fase di ripristino. Una volta completata, la configurazione dell'indice passerà allo stesso stato del campo specificato da ancestor_field, dopodiché il valore di uses_ancestor_config sarà true e reverting sarà false.

FieldOperationMetadata

I metadati per google.longrunning.Operation risultati da FirestoreAdmin.UpdateField.

Campi
start_time

Timestamp

L'ora di inizio dell'operazione.
end_time

Timestamp

L'ora del completamento dell'operazione. Il set di dati non verrà impostato se l'operazione è ancora in corso.
field

string

La risorsa di campo su cui agisce questa operazione. Ad esempio: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

Un elenco di IndexConfigDelta, che descrive l'intento di questa operazione.
state

OperationState

Lo stato dell'operazione.
document_progress

Progress

L'avanzamento, in documenti, di questa operazione.
bytes_progress

Progress

L'avanzamento, in byte, di questa operazione.

IndexConfigDelta

Informazioni su una modifica alla configurazione dell'indice.

Campi
change_type

ChangeType

Specifica come cambia l'indice.
index

Index

L'indice in fase di modifica.

ChangeType

Specifica come cambia l'indice.

Enum
CHANGE_TYPE_UNSPECIFIED Il tipo di modifica non è specificato o noto.
ADD È in corso l'aggiunta dell'indice a campo singolo.
REMOVE L'indice a campo singolo è in fase di rimozione.

GetFieldRequest

La richiesta di FirestoreAdmin.GetField.

Campi
name

string

Un nome del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

La richiesta di FirestoreAdmin.GetIndex.

Campi
name

string

Un nome del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

I metadati per google.longrunning.Operation risultati da FirestoreAdmin.ImportDocuments.

Campi
start_time

Timestamp

L'ora di inizio dell'operazione.
end_time

Timestamp

L'ora del completamento dell'operazione. Il set di dati non verrà impostato se l'operazione è ancora in corso.
operation_state

OperationState

Lo stato dell'operazione di importazione.
progress_documents

Progress

L'avanzamento, in documenti, di questa operazione.
progress_bytes

Progress

L'avanzamento, in byte, di questa operazione.
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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Indice

Gli indici di Cloud Firestore consentono di eseguire query semplici e complesse sui documenti di un database.

Campi
name

string

Solo output. Un nome definito dal server per questo indice. Il nome utilizzato per gli indici composti sarà: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Per gli indici a campo singolo, questo campo sarà vuoto.
query_scope

QueryScope

Gli indici con un ambito di query di raccolta specificato consentono di eseguire query su una raccolta che è l'elemento figlio di un documento specifico, specificato al momento della query e che ha lo stesso ID raccolta.

Gli indici con un ambito di query del gruppo di raccolte specificato consentono di eseguire query su tutte le raccolte discese da un documento specifico, specificato al momento della query e che hanno lo stesso ID raccolta di questo indice.
fields[]

IndexField

I campi supportati da questo indice.

Per gli indici composti, sono sempre due o più campi. L'ultimo campo inserito si riferisce sempre al percorso del campo __name__. Se, al momento della creazione, __name__ non è stato specificato come ultimo campo, verrà aggiunto automaticamente con la stessa direzione dell'ultimo campo definito. Se il campo finale in un indice composto non è direzionale, __name__ verrà ordinato IN ordine crescente (se non diversamente specificato in modo esplicito).

Per gli indici a campo singolo, sarà sempre esattamente una voce con un percorso del campo uguale a quello del campo associato.
state

State

Solo output. Lo stato di elaborazione dell'indice.

IndexField

Un campo in un indice. Il campo field_path indica quale campo viene indicizzato, mentre value_mode descrive il modo in cui viene indicizzato il valore del campo.

Campi
field_path

string

Può essere name. Per gli indici a campo singolo, deve corrispondere al nome del campo o può essere omesso.
Campo di unione value_mode. Modalità di indicizzazione del valore del campo. value_mode può essere solo uno dei seguenti:
order

Order

Indica che questo campo supporta l'ordinamento in base all'ordine specificato o il confronto utilizzando =, <, <=, >, >=.
array_config

ArrayConfig

Indica che questo campo supporta le operazioni su array_value.

ArrayConfig

Le configurazioni dei valori di array supportate.

Enum
ARRAY_CONFIG_UNSPECIFIED L'indice non supporta query dell'array aggiuntive.
CONTAINS L'indice supporta le query di contenimento degli array.

Ordine

Gli ordinamenti supportati.

Enum
ORDER_UNSPECIFIED L'ordinamento non è specificato. Opzione non valida.
ASCENDING Il campo viene ordinato in base al valore del campo crescente.
DESCENDING Il campo viene ordinato in base al valore decrescente.

QueryScope

L'ambito della query definisce l'ambito in cui viene eseguita una query. Questo valore viene specificato nel campo from di StructuredQuery.

Enum
QUERY_SCOPE_UNSPECIFIED L'ambito della query non è specificato. Opzione non valida.
COLLECTION Gli indici con un ambito di query di raccolta specificato consentono di eseguire query su una raccolta che è l'elemento figlio di un documento specifico, specificato al momento della query e con l'ID raccolta specificato dall'indice.
COLLECTION_GROUP Gli indici con un ambito di query del gruppo di raccolte specificato consentono di eseguire query su tutte le raccolte con l'ID raccolta specificato dall'indice.

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 si verifica un problema durante la creazione dell'indice, l'indice passerà allo stato NEEDS_REPAIR.

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.
NEEDS_REPAIR 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. Utilizza l'API google.longrunning.Operations per determinare il motivo per cui l'ultimo tentativo di creazione di questo indice non è riuscito, quindi ricrea l'indice.

IndexOperationMetadata

I metadati per google.longrunning.Operation risultati da FirestoreAdmin.CreateIndex.

Campi
start_time

Timestamp

L'ora di inizio dell'operazione.
end_time

Timestamp

L'ora del completamento dell'operazione. Il set di dati non verrà impostato se l'operazione è ancora in corso.
index

string

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

OperationState

Lo stato dell'operazione.
progress_documents

Progress

L'avanzamento, in documenti, di questa operazione.
progress_bytes

Progress

L'avanzamento, in byte, di questa operazione.

ListFieldsRequest

La richiesta di FirestoreAdmin.ListFields.

Campi
parent

string

Un nome principale del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Il filtro da applicare ai risultati dell'elenco. Attualmente, FirestoreAdmin.ListFields supporta solo i campi dell'elenco di cui è stato eseguito l'override esplicito. Per eseguire questa query, chiama FirestoreAdmin.ListFields con il filtro impostato su indexConfig.usesAncestorConfig:false.
page_size

int32

Il numero di risultati da restituire.
page_token

string

Un token di pagina, restituito da una precedente chiamata a FirestoreAdmin.ListFields, che può essere utilizzato per ricevere la pagina dei risultati successiva.

ListFieldsResponse

La risposta per FirestoreAdmin.ListFields.

Campi
fields[]

Field

I campi richiesti.
next_page_token

string

Un token di pagina che può essere utilizzato per richiedere un'altra pagina di risultati. Se vuota, si tratta dell'ultima pagina.

ListIndexesRequest

La richiesta di FirestoreAdmin.ListIndexes.

Campi
parent

string

Un nome principale del modulo projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Il filtro da applicare ai risultati dell'elenco.
page_size

int32

Il numero di risultati da restituire.
page_token

string

Un token di pagina, restituito da una precedente chiamata a FirestoreAdmin.ListIndexes, che può essere utilizzato per ricevere la pagina dei risultati successiva.

ListIndexesResponse

La risposta per FirestoreAdmin.ListIndexes.

Campi
indexes[]

Index

Gli indici richiesti.
next_page_token

string

Un token di pagina che può essere utilizzato per richiedere un'altra pagina di risultati. Se vuota, si tratta dell'ultima pagina.

OperationState

Descrive lo stato dell'operazione.

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

Descrive l'avanzamento dell'operazione. L'unità di lavoro è generica e deve essere interpretata in base a dove viene utilizzato Progress.

Campi
estimated_work

int64

La quantità di lavoro stimata.
completed_work

int64

La quantità di lavoro completata.

UpdateFieldRequest

La richiesta di FirestoreAdmin.UpdateField.

Campi
field

Field

Il campo da aggiornare.
update_mask

FieldMask

Una maschera relativa al campo. Se specificato, solo la configurazione specificata da questa maschera di campo verrà aggiornata nel campo.