FieldOperationMetadata

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

Rappresentazione JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Campi
startTime

string (Timestamp format)

L'ora di inizio dell'operazione.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

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

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

field

string

La risorsa di campo su cui agisce questa operazione. Ad esempio: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

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

state

enum (OperationState)

Lo stato dell'operazione.

progressDocuments

object (Progress)

L'avanzamento, in documenti, di questa operazione.

progressBytes

object (Progress)

L'avanzamento, in byte, di questa operazione.

ttlConfigDelta

object (TtlConfigDelta)

Descrive i delta della configurazione TTL.

IndexConfigDelta

Informazioni su una modifica alla configurazione dell'indice.

Rappresentazione JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Campi
changeType

enum (ChangeType)

Specifica come cambia l'indice.

index

object (Index)

L'indice in fase di modifica.

Indice

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

Rappresentazione JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campi
name

string

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

queryScope

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

enum (ApiScope)

L'ambito API supportato da questo indice.

fields[]

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

enum (State)

Solo output. Lo stato di elaborazione dell'indice.

IndexField

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

Rappresentazione JSON
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
Campi
fieldPath

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

enum (Order)

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

arrayConfig

enum (ArrayConfig)

Indica che questo campo supporta le operazioni su arrayValue.

vectorConfig

object (VectorConfig)

Indica che questo campo supporta i vicini più prossimi e le operazioni sulla distanza sul vettore.

VectorConfig

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

Rappresentazione JSON
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
Campi
dimension

integer

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

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

TtlConfigDelta

Informazioni su una modifica alla configurazione TTL.

Rappresentazione JSON
{
  "changeType": enum (ChangeType)
}
Campi
changeType

enum (ChangeType)

Specifica come cambia la configurazione TTL.