Package google.firestore.admin.v1

string

Solo output. Il nome univoco della risorsa del backup.

Il formato è projects/{project}/locations/{location}/backups/{backup}.

string

Solo output. Nome del database Firestore da cui proviene il backup.

Il formato è projects/{project}/databases/{database}.

string

Solo output. L'UUID4 generato dal sistema per il database Firestore da cui proviene il backup.

Timestamp

Solo output. Al momento il backup contiene una copia del database coerente esternamente.

Timestamp

Solo output. Il timestamp di scadenza del backup.

State

Solo output. Lo stato attuale del backup.

string

Solo output. L'identificatore univoco della pianificazione dei backup in tutte le località e tutti i database per il progetto specificato.

Verrà assegnato automaticamente.

Il formato è projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Timestamp

Solo output. Il timestamp in cui è stata creata la pianificazione del backup ed è in vigore da allora.

Non verranno creati backup per questa pianificazione prima di questa data.

Timestamp

Solo output. Il timestamp in cui questa pianificazione del backup è stata aggiornata più di recente. Quando una pianificazione del backup viene creata per la prima volta, corrisponde a create_time.

Duration

In quale momento relativo nel futuro, rispetto all'ora di creazione, il backup deve essere eliminato, ad esempio conserva i backup per 7 giorni.

DailyRecurrence

Per una pianificazione che viene eseguita ogni giorno.

WeeklyRecurrence

Per una pianificazione che viene eseguita settimanalmente in un giorno specifico.

string

obbligatorio. Il database padre.

Formatta projects/{project}/databases/{database}

BackupSchedule

obbligatorio. La pianificazione del backup da creare.

string

obbligatorio. Un nome principale del modulo projects/{project_id}

Database

obbligatorio. Il database da creare.

string

obbligatorio. L'ID da utilizzare per il database, che diventerà il componente finale del nome della risorsa del database.

Questo valore deve contenere da 4 a 63 caratteri. I caratteri validi sono /[a-z][0-9]-/, con il primo carattere una lettera e l'ultimo una lettera o un numero. Non deve essere simile all'UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

È valido anche l'ID database "(predefinito)".

string

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

Index

obbligatorio. L'indice composto da creare.

string

Il nome della risorsa del database. Formato: projects/{project}/databases/{database}

string

Solo output. L'UUID4 generato dal sistema per questo database.

Timestamp

Solo output. Il timestamp in cui è stato creato il database. I database creati prima del 2016 non popolano create_time.

Timestamp

Solo output. Il timestamp in cui il database è stato aggiornato più di recente. Tieni presente che sono inclusi solo gli aggiornamenti della risorsa di database e non i dati contenuti dal database.

string

La posizione del database. Le località disponibili sono elencate all'indirizzo https://cloud.google.com/firestore/docs/locations.

DatabaseType

Il tipo di database. Consulta https://cloud.google.com/datastore/docs/firestore-or-datastore per informazioni su come scegliere.

ConcurrencyMode

La modalità di controllo della contemporaneità da utilizzare per questo database.

Duration

Solo output. Il periodo durante il quale le versioni precedenti dei dati vengono conservate nel database.

Qualsiasi read o query può specificare un read_time all'interno di questa finestra e leggerà lo stato del database in quel momento.

Se la funzionalità PITR è abilitata, il periodo di conservazione è di 7 giorni. In caso contrario, il periodo di conservazione è di 1 ora.

Timestamp

Solo output. Il timestamp più recente in cui è possibile leggere dal database le versioni precedenti dei dati. Vedi [version_retention_period] sopra. Questo campo viene compilato con il campo now - version_retention_period.

Questo valore viene aggiornato continuamente e diventa inattivo nel momento in cui viene eseguita la query. Se utilizzi questo valore per recuperare i dati, assicurati di tenere conto del tempo compreso tra il momento in cui viene eseguita la query sul valore e quello in cui avvii il ripristino.

PointInTimeRecoveryEnablement

Indica se abilitare la funzionalità PITR in questo database.

AppEngineIntegrationMode

La modalità di integrazione di App Engine da utilizzare per questo database.

string

Solo output. Il prefisso key_prefix per questo database. Questo prefisso_chiave viene utilizzato in combinazione con l'ID progetto ("~") per creare l'ID applicazione restituito dalle API Cloud Datastore nei runtime di prima generazione di Google App Engine.

Questo valore può essere vuoto. In questo caso l'appid da utilizzare per le chiavi con codifica URL è project_id (ad esempio: foo anziché v~foo).

DeleteProtectionState

Stato della protezione da eliminazione per il database.

string

Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere.

string

obbligatorio. Nome del backup da eliminare.

è projects/{project}/locations/{location}/backups/{backup}.

string

obbligatorio. Il nome della pianificazione del backup.

Formatta projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

obbligatorio. Un nome del modulo projects/{project_id}/databases/{database_id}

string

L'etag corrente del database. Se viene fornito un etag che non corrisponde all'etag corrente del database, l'eliminazione verrà bloccata e verrà restituito un errore FAILED_PRECONDITION.

string

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

Timestamp

L'ora di inizio dell'operazione.

Timestamp

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

OperationState

Lo stato dell'operazione di esportazione.

Progress

L'avanzamento, in documenti, di questa operazione.

Progress

L'avanzamento, in byte, di questa operazione.

string

Quali ID raccolta vengono esportati.

string

Località in cui vengono esportati i documenti.

string

Gli ID degli spazi dei nomi che vengono esportati.

Timestamp

Il timestamp corrispondente alla versione del database in fase di esportazione. Se questo criterio non viene specificato, non viene fornita alcuna garanzia sulla coerenza dei documenti esportati.

string

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

string

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

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.

string

Un elenco vuoto rappresenta tutti gli spazi dei nomi. Questo è l'utilizzo preferito per i database che non utilizzano spazi dei nomi.

Una stringa vuota rappresenta lo spazio dei nomi predefinito. Questa opzione deve essere utilizzata se il database contiene dati in spazi dei nomi non predefiniti, ma non vuole includerli. Ogni spazio dei nomi in questo elenco deve essere univoco.

Timestamp

Il timestamp corrispondente alla versione del database da esportare. Il timestamp deve essere nel passato, arrotondato al minuto e non anteriore a earliestVersionTime. Se specificato, i documenti esportati rappresenteranno una visualizzazione coerente del database al momento specificato. In caso contrario, non vi sono garanzie sulla coerenza dei documenti esportati.

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.

string

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

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.

TtlConfig

La configurazione TTL per questo Field. L'impostazione o la disattivazione di questa opzione attiverà o disattiverà il TTL per i documenti che hanno questo Field.

Index

Gli indici supportati per questo campo.

bool

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

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

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.

State

Solo output. Lo stato della configurazione TTL.

Timestamp

L'ora di inizio dell'operazione.

Timestamp

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

string

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

IndexConfigDelta

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

OperationState

Lo stato dell'operazione.

Progress

L'avanzamento, in documenti, di questa operazione.

Progress

L'avanzamento, in byte, di questa operazione.

TtlConfigDelta

Descrive i delta della configurazione TTL.

ChangeType

Specifica come cambia l'indice.

Index

L'indice in fase di modifica.

ChangeType

Specifica come cambia la configurazione TTL.

string

obbligatorio. Nome del backup da recuperare.

Il formato è projects/{project}/locations/{location}/backups/{backup}.

string

obbligatorio. Il nome della pianificazione del backup.

Formatta projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

obbligatorio. Un nome del modulo projects/{project_id}/databases/{database_id}

string

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

string

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

Timestamp

L'ora di inizio dell'operazione.

Timestamp

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

OperationState

Lo stato dell'operazione di importazione.

Progress

L'avanzamento, in documenti, di questa operazione.

Progress

L'avanzamento, in byte, di questa operazione.

string

Gli ID raccolta che vengono importati.

string

La posizione dei documenti da importare.

string

Gli ID dello spazio dei nomi che vengono importati.

string

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

string

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

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

string

Un elenco vuoto rappresenta tutti gli spazi dei nomi. Questo è l'utilizzo preferito per i database che non utilizzano spazi dei nomi.

Una stringa vuota rappresenta lo spazio dei nomi predefinito. Questa opzione deve essere utilizzata se il database contiene dati in spazi dei nomi non predefiniti, ma non vuole includerli. Ogni spazio dei nomi in questo elenco deve essere univoco.

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.

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.

ApiScope

L'ambito API supportato da questo indice.

IndexField

I campi supportati da questo indice.

Per gli indici composti, sono necessari un minimo di 2 e un massimo di 100 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

Solo output. Lo stato di elaborazione dell'indice.

string

Può essere name. Per gli indici a campo singolo, deve corrispondere al nome del campo o può essere omesso.

Order

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

ArrayConfig

Indica che questo campo supporta le operazioni su array_value.

VectorConfig

Indica che questo campo supporta le operazioni sul vicino più prossimo e sulla distanza sul vettore.

int32

obbligatorio. La dimensione vettoriale a cui si applica questa configurazione.

L'indice risultante includerà solo i vettori di questa dimensione e potrà essere utilizzato per la ricerca vettoriale con la stessa dimensione.

FlatIndex

Indica che l'indice vettoriale è un indice fisso.

Timestamp

L'ora di inizio dell'operazione.

Timestamp

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

string

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

OperationState

Lo stato dell'operazione.

Progress

L'avanzamento, in documenti, di questa operazione.

Progress

L'avanzamento, in byte, di questa operazione.

string

obbligatorio. Il database padre.

Il formato è projects/{project}/databases/{database}.

BackupSchedule

Elenco di tutte le pianificazioni dei backup.

string

obbligatorio. La posizione da cui elencare i backup.

Il formato è projects/{project}/locations/{location}. Utilizza {location} = '-' per elencare i backup da tutte le posizioni per il progetto specificato. Ciò consente di elencare i backup da un'unica posizione o da tutte le posizioni.

Backup

Elenco di tutti i backup per il progetto.

string

Elenco delle posizioni da cui non è stato possibile recuperare i backup esistenti.

Invece di non completare tutte le richieste quando una singola località non è raggiungibile, questa risposta restituisce un set di risultati parziale e un elenco di località che non è possibile raggiungere qui. È possibile ritentare la richiesta per una singola posizione per generare un errore concreto.

string

obbligatorio. Un nome principale del modulo projects/{project_id}

Database

I database nel progetto.

string

Nel caso in cui non sia possibile elencare i dati relativi ai singoli database, questi verranno registrati qui.

Una voce di esempio potrebbe essere: projects/some_project/locations/some_location. Questo può accadere se la regione Cloud in cui risiede il database non è al momento disponibile. In questo caso non è possibile recuperare tutti i dettagli del database. Potresti ricevere un messaggio di errore più dettagliato (o recuperare la risorsa) inviando una richiesta di recupero per la risorsa o una richiesta di elenco per la località specifica.

string

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

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 un filtro che include indexConfig.usesAncestorConfig:false .

int32

Il numero di risultati da restituire.

string

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

Field

I campi richiesti.

string

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

string

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

string

Il filtro da applicare ai risultati dell'elenco.

int32

Il numero di risultati da restituire.

string

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

Index

Gli indici richiesti.

string

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

int64

La quantità di lavoro stimata.

int64

La quantità di lavoro completata.

Timestamp

L'ora in cui è stato avviato il ripristino.

Timestamp

L'ora di completamento del ripristino, non impostata per i ripristini in corso.

OperationState

Lo stato dell'operazione del ripristino.

string

Il nome del database in cui eseguire il ripristino.

string

Il nome del backup da cui è stato eseguito il ripristino.

Progress

Il tempo necessario al ripristino, sotto forma di percentuale stimata di tempo rimanente.

string

obbligatorio. Il progetto in cui ripristinare il database. Il formato è projects/{project_id}.

string

obbligatorio. L'ID da utilizzare per il database, che diventerà il componente finale del nome della risorsa del database. Questo ID database non deve essere associato a un database esistente.

Questo valore deve contenere da 4 a 63 caratteri. I caratteri validi sono /[a-z][0-9]-/, con il primo carattere una lettera e l'ultimo una lettera o un numero. Non deve essere simile all'UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

È valido anche l'ID database "(predefinito)".

string

Backup da cui eseguire il ripristino. Deve provenire dallo stesso progetto dell'elemento padre.

Il formato è: projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

obbligatorio. La pianificazione del backup da aggiornare.

FieldMask

L'elenco dei campi da aggiornare.

Database

obbligatorio. Il database da aggiornare.

FieldMask

L'elenco dei campi da aggiornare.

Field

obbligatorio. Il campo da aggiornare.

FieldMask

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

DayOfWeek

Il giorno della settimana dell'esecuzione.

DAY_OF_WEEK_UNSPECIFIED non consentito.