REST Resource: projects.databases.collectionGroups.fields

Risorsa: 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.

Rappresentazione JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Campi
name

string

Obbligatoria. Un nome di campo nel modulo projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Un percorso di campo può essere un nome di campo semplice (ad es. address) o un percorso dei campi all'interno di mapValue (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/{projectId}/databases/{databaseId}/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

object (IndexConfig)

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

object (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.

Rappresentazione JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Campi
indexes[]

object (Index)

Gli indici supportati per questo campo.
usesAncestorConfig

boolean

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

string

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

boolean

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 ancestorField, dopodiché il valore di usesAncestorConfig 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.

Rappresentazione JSON 
{
  "state": enum (State)
}
Campi
state

enum (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.

Metodi

get

 Recupera i metadati e la configurazione di un campo.

list

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

patch

 Aggiorna la configurazione di un campo.