Package google.firestore.admin.v1

Indice

FirestoreAdmin

L'API Cloud Firestore Admin.

Questa API fornisce diversi servizi amministrativi per Cloud Firestore.

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

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

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.

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 eseguita potrebbe essere eliminata in modo che non sia più elencata come parte della raccolta delle operazioni. Le operazioni sono la raccolta dei rifiuti dopo 30 giorni. Per impostazione predefinita, ListOperations restituirà solo le operazioni in corso e non riuscite. Per elencare l'operazione completata, invia una richiesta ListOperations con il filtro done: true.

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

CreateBackupSchedule

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Crea una pianificazione del backup su un database. In un database possono essere configurate al massimo due pianificazioni di backup: una pianificazione del backup giornaliera con conservazione fino a 7 giorni e una pianificazione dei backup settimanale con conservazione fino a 14 settimane.

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.

CreateDatabase

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Creare un database.

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.

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.

DeleteBackup

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Elimina un backup.

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.

DeleteBackupSchedule

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Elimina una pianificazione del backup.

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.

DeleteDatabase

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Elimina un database.

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.

Per maggiori dettagli sul comportamento di esportazione e sul formato dell'output, consulta: https://cloud.google.com/firestore/docs/manage-data/export-import

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.

GetBackup

rpc GetBackup(GetBackupRequest) returns (Backup)

Recupera le informazioni su un backup.

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.

GetBackupSchedule

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Recupera le informazioni su una pianificazione del backup.

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.

GetDatabase

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Recupera le informazioni su un database.

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.

ListBackupSchedules

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Elenca le pianificazioni dei backup.

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.

ListBackups

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Elenca tutti i backup.

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.

ListDatabases

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Elenca tutti i database nel progetto.

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 o ttlConfig:*.

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.

RestoreDatabase

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Crea un nuovo database ripristinando un backup esistente.

Il nuovo database deve trovarsi nella stessa regione cloud o località a più regioni del backup esistente. Questo comportamento è simile a [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], tranne che per la creazione di un nuovo database vuoto, ne viene creato uno nuovo con il tipo di database, la configurazione dell'indice e i documenti di un backup esistente.

Il valore long-running operation può essere utilizzato per monitorare l'avanzamento del ripristino, dove il tipo di campo metadata dell'operazione corrisponde a RestoreDatabaseMetadata. Il tipo response è Database se il ripristino è riuscito. Il nuovo database non sarà leggibile o scrivibile fino al completamento dell'LRO.

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.

UpdateBackupSchedule

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Aggiorna una pianificazione del backup.

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.

UpdateDatabase

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Aggiorna un database.

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.

Backup

Un backup di un database Cloud Firestore.

Il backup contiene tutti i documenti e le configurazioni degli indici per il database specificato in un determinato momento.

Campi
name

string

Solo output. Il nome univoco della risorsa del backup.

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

database

string

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

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

database_uid

string

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

snapshot_time

Timestamp

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

expire_time

Timestamp

Solo output. Il timestamp di scadenza del backup.

state

State

Solo output. Lo stato attuale del backup.

Stato

Indica lo stato attuale del backup.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
CREATING Il backup in attesa è ancora in fase di creazione. Le operazioni sul backup verranno rifiutate in questo stato.
READY Il backup è stato completato ed è pronto per essere utilizzato.
NOT_AVAILABLE Il backup non è disponibile in questo momento.

BackupSchedule

Una pianificazione del backup per un database Cloud Firestore.

Questa risorsa è di proprietà del database di cui esegue il backup e viene eliminata insieme al database. Tuttavia, i backup effettivi non lo sono.

Campi
name

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}

create_time

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.

update_time

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.

retention

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.

Campo di unione recurrence. Un campo unico per indicare quando verranno eseguiti i backup. recurrence può essere solo uno dei seguenti:
daily_recurrence

DailyRecurrence

Per una pianificazione che viene eseguita ogni giorno.

weekly_recurrence

WeeklyRecurrence

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

CreateBackupScheduleRequest

La richiesta di FirestoreAdmin.CreateBackupSchedule.

Campi
parent

string

obbligatorio. Il database padre.

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

backup_schedule

BackupSchedule

obbligatorio. La pianificazione del backup da creare.

CreateDatabaseMetadata

Questo tipo non contiene campi.

Metadati relativi all'operazione di creazione del database.

CreateDatabaseRequest

La richiesta di FirestoreAdmin.CreateDatabase.

Campi
parent

string

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

database

Database

obbligatorio. Il database da creare.

database_id

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

CreateIndexRequest

La richiesta di FirestoreAdmin.CreateIndex.

Campi
parent

string

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

index

Index

obbligatorio. L'indice composto da creare.

DailyRecurrence

Questo tipo non contiene campi.

Rappresenta una pianificazione ricorrente eseguita ogni giorno a una determinata ora.

Il fuso orario è UTC.

Database

Un database Cloud Firestore.

Campi
name

string

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

uid

string

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

create_time

Timestamp

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

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

location_id

string

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

type

DatabaseType

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

concurrency_mode

ConcurrencyMode

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

version_retention_period

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.

earliest_version_time

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.

point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Indica se abilitare la funzionalità PITR in questo database.

app_engine_integration_mode

AppEngineIntegrationMode

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

key_prefix

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

delete_protection_state

DeleteProtectionState

Stato della protezione da eliminazione per il database.

etag

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.

AppEngineIntegrationMode

Il tipo di modalità di integrazione di App Engine.

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Non utilizzato.
ENABLED Se un'applicazione App Engine esiste nella stessa regione di questo database, la configurazione di App Engine influirà su questo database. Ciò include la disattivazione dell'applicazione e del database e la disabilitazione delle scritture sul database.
DISABLED

App Engine non influisce sulla capacità di questo database di gestire le richieste.

Questa è l'impostazione predefinita per i database creati con l'API Firestore.

ConcurrencyMode

Il tipo di modalità di controllo della contemporaneità per le transazioni.

Enum
CONCURRENCY_MODE_UNSPECIFIED Non utilizzato.
OPTIMISTIC Utilizza il controllo ottimistico della contemporaneità per impostazione predefinita. Questa modalità è disponibile per i database Cloud Firestore.
PESSIMISTIC

Utilizza il controllo della contemporaneità pessimistica per impostazione predefinita. Questa modalità è disponibile per i database Cloud Firestore.

Questa è l'impostazione predefinita per Cloud Firestore.

OPTIMISTIC_WITH_ENTITY_GROUPS

Utilizza il controllo ottimistico della contemporaneità con i gruppi di entità per impostazione predefinita.

Questa è l'unica modalità disponibile per Cloud Datastore.

Questa modalità è disponibile anche per Cloud Firestore con la modalità Datastore, ma non è consigliata.

DatabaseType

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

Le modifiche alla modalità sono consentite solo se il database è vuoto.

Enum
DATABASE_TYPE_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se il tipo di database viene omesso.
FIRESTORE_NATIVE Modalità Native Firestore
DATASTORE_MODE Firestore in modalità Datastore.

DeleteProtectionState

Lo stato della protezione Elimina del database.

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED Il valore predefinito. Il tipo di protezione Elimina non è specificato
DELETE_PROTECTION_DISABLED L'eliminazione della protezione è disabilitata
DELETE_PROTECTION_ENABLED L'eliminazione della protezione è abilitata

PointInTimeRecoveryEnablement

Attivazione della funzionalità di recupero point-in-time.

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Non utilizzato.
POINT_IN_TIME_RECOVERY_ENABLED

Le letture sono supportate su versioni selezionate dei dati degli ultimi 7 giorni:

  • Legge in base a qualsiasi timestamp dell'ultima ora
  • Lettura in base a istantanee di 1 minuto per oltre 1 ora ed entro 7 giorni

Per determinare le versioni supportate puoi utilizzare version_retention_period e earliest_version_time.

POINT_IN_TIME_RECOVERY_DISABLED Le letture sono supportate su qualsiasi versione dei dati entro l'ultima ora.

DeleteBackupRequest

La richiesta di FirestoreAdmin.DeleteBackup.

Campi
name

string

obbligatorio. Nome del backup da eliminare.

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

DeleteBackupScheduleRequest

La richiesta di [FirestoreAdmin.DeleteBackupSchedules][].

Campi
name

string

obbligatorio. Il nome della pianificazione del backup.

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

DeleteDatabaseMetadata

Questo tipo non contiene campi.

Metadati relativi all'operazione di eliminazione del database.

DeleteDatabaseRequest

La richiesta di FirestoreAdmin.DeleteDatabase.

Campi
name

string

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

etag

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.

DeleteIndexRequest

La richiesta di FirestoreAdmin.DeleteIndex.

Campi
name

string

obbligatorio. 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 esportati i documenti.

namespace_ids[]

string

Gli ID degli spazi dei nomi che vengono esportati.

snapshot_time

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.

ExportDocumentsRequest

La richiesta di FirestoreAdmin.ExportDocuments.

Campi
name

string

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

namespace_ids[]

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.

snapshot_time

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.

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.

Campo

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

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.

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.

ttl_config

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.

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 sulla base della 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.

TtlConfig

La configurazione TTL (time-to-live) per i documenti per i quali è impostato questo Field.

L'archiviazione di un valore di timestamp in un campo abilitato per TTL viene considerata come la data e l'ora di scadenza assoluta del documento. I valori timestamp nel passato indicano che il documento è idoneo per la scadenza immediata. Se utilizzi qualsiasi altro tipo di dati o lasci il campo mancante, la scadenza del singolo documento viene disattivata.

Campi
state

State

Solo output. Lo stato della configurazione TTL.

Stato

Lo stato di applicazione della configurazione TTL a tutti i documenti.

Enum
STATE_UNSPECIFIED Lo stato non è specificato o è sconosciuto.
CREATING Il TTL è in fase di applicazione. È attiva un'operazione a lunga esecuzione per monitorare la modifica. Ai nuovi documenti scritti verranno applicati i TTL come richiesto. I TTL richiesti sui documenti esistenti sono ancora in fase di elaborazione. Una volta elaborati i TTL su tutti i documenti esistenti, lo stato passerà a "ATTIVO".
ACTIVE Il TTL è attivo per tutti i documenti.
NEEDS_REPAIR Impossibile abilitare la configurazione TTL per tutti i documenti esistenti. Ai nuovi documenti scritti continuerà a essere applicato il relativo TTL. L'LRO restituito durante l'ultimo tentativo di abilitare il TTL per questo Field non è riuscito e potrebbe contenere ulteriori dettagli.

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.

progress_documents

Progress

L'avanzamento, in documenti, di questa operazione.

progress_bytes

Progress

L'avanzamento, in byte, di questa operazione.

ttl_config_delta

TtlConfigDelta

Descrive i delta della configurazione TTL.

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.

TtlConfigDelta

Informazioni su una modifica alla configurazione TTL.

Campi
change_type

ChangeType

Specifica come cambia la configurazione TTL.

ChangeType

Specifica come cambia la configurazione TTL.

Enum
CHANGE_TYPE_UNSPECIFIED Il tipo di modifica non è specificato o noto.
ADD È in corso l'aggiunta della configurazione TTL.
REMOVE La configurazione TTL è in fase di rimozione.

GetBackupRequest

La richiesta di FirestoreAdmin.GetBackup.

Campi
name

string

obbligatorio. Nome del backup da recuperare.

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

GetBackupScheduleRequest

La richiesta di FirestoreAdmin.GetBackupSchedule.

Campi
name

string

obbligatorio. Il nome della pianificazione del backup.

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

GetDatabaseRequest

La richiesta di FirestoreAdmin.GetDatabase.

Campi
name

string

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

GetFieldRequest

La richiesta di FirestoreAdmin.GetField.

Campi
name

string

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

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

namespace_ids[]

string

Gli ID dello spazio dei nomi che vengono importati.

ImportDocumentsRequest

La richiesta di FirestoreAdmin.ImportDocuments.

Campi
name

string

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

namespace_ids[]

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.

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.

api_scope

ApiScope

L'ambito API supportato da questo indice.

fields[]

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

State

Solo output. Lo stato di elaborazione dell'indice.

ApiScope

L'ambito API definisce le API (Firestore Native o Firestore in modalità Datastore) supportate per le query.

Enum
ANY_API L'indice può essere utilizzato solo dall'API di query Native Firestore. Questa è l'impostazione predefinita.
DATASTORE_MODE_API L'indice può essere utilizzato solo dall'API di query Firestore in modalità Datastore.

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.

vector_config

VectorConfig

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

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.

VectorConfig

La configurazione dell'indice per supportare le operazioni di ricerca vettoriale

Campi
dimension

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.

Campo di unione type. Il tipo di indice utilizzato. type può essere solo uno dei seguenti:
flat

FlatIndex

Indica che l'indice vettoriale è un indice fisso.

FlatIndex

Questo tipo non contiene campi.

Un indice che memorizza i vettori in una struttura di dati piatti e supporta la ricerca esaustiva.

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.
COLLECTION_RECURSIVE Includi nell'indice tutti i predecessori delle raccolte. Disponibile solo per i database in modalità Datastore.

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.

ListBackupSchedulesRequest

La richiesta di FirestoreAdmin.ListBackupSchedules.

Campi
parent

string

obbligatorio. Il database padre.

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

ListBackupSchedulesResponse

La risposta per FirestoreAdmin.ListBackupSchedules.

Campi
backup_schedules[]

BackupSchedule

Elenco di tutte le pianificazioni dei backup.

ListBackupsRequest

La richiesta di FirestoreAdmin.ListBackups.

Campi
parent

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.

ListBackupsResponse

La risposta per FirestoreAdmin.ListBackups.

Campi
backups[]

Backup

Elenco di tutti i backup per il progetto.

unreachable[]

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.

ListDatabasesRequest

Una richiesta per elencare i database Firestore in tutte le località per un progetto.

Campi
parent

string

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

ListDatabasesResponse

L'elenco di database per un progetto.

Campi
databases[]

Database

I database nel progetto.

unreachable[]

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.

ListFieldsRequest

La richiesta di FirestoreAdmin.ListFields.

Campi
parent

string

obbligatorio. 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 un filtro che include 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

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

LocationMetadata

Questo tipo non contiene campi.

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

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.

RestoreDatabaseMetadata

Metadati per long-running operation della richiesta [RipristinaDatabase][google.firestore.admin.v1.RipristinaDatabase].

Campi
start_time

Timestamp

L'ora in cui è stato avviato il ripristino.

end_time

Timestamp

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

operation_state

OperationState

Lo stato dell'operazione del ripristino.

database

string

Il nome del database in cui eseguire il ripristino.

backup

string

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

progress_percentage

Progress

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

RestoreDatabaseRequest

Il messaggio di richiesta per [FirestoreAdmin.careDatabase][google.firestore.admin.v1.corso di ripristino].

Campi
parent

string

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

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

Campo di unione source.

source può essere solo uno dei seguenti:

backup

string

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

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

UpdateBackupScheduleRequest

La richiesta di FirestoreAdmin.UpdateBackupSchedule.

Campi
backup_schedule

BackupSchedule

obbligatorio. La pianificazione del backup da aggiornare.

update_mask

FieldMask

L'elenco dei campi da aggiornare.

UpdateDatabaseMetadata

Questo tipo non contiene campi.

Metadati relativi all'operazione di aggiornamento del database.

UpdateDatabaseRequest

La richiesta di FirestoreAdmin.UpdateDatabase.

Campi
database

Database

obbligatorio. Il database da aggiornare.

update_mask

FieldMask

L'elenco dei campi da aggiornare.

UpdateFieldRequest

La richiesta di FirestoreAdmin.UpdateField.

Campi
field

Field

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

WeeklyRecurrence

Rappresenta una pianificazione ricorrente eseguita in un giorno della settimana specificato.

Il fuso orario è UTC.

Campi
day

DayOfWeek

Il giorno della settimana dell'esecuzione.

DAY_OF_WEEK_UNSPECIFIED non consentito.