FieldOperationMetadata

FirestoreAdmin.UpdateField에서 검색한 google.longrunning.Operation 결과에 대한 메타데이터입니다.

JSON 표현
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
입력란
startTime

string (Timestamp format)

이 작업이 시작된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

endTime

string (Timestamp format)

이 작업이 완료된 시간입니다. 작업이 계속 진행 중이면 설정되지 않습니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

field

string

이 작업이 작동하는 필드 리소스입니다. 예: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

이 작업의 인텐트를 설명하는 IndexConfigDelta 목록입니다.

state

enum (OperationState)

작업의 상태입니다.

progressDocuments

object (Progress)

문서 내 이 작업의 진행 상황입니다.

progressBytes

object (Progress)

이 작업의 진행률(바이트)입니다.

ttlConfigDelta

object (TtlConfigDelta)

TTL 구성의 델타를 설명합니다.

IndexConfigDelta

색인 구성 변경에 대한 정보입니다.

JSON 표현
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
입력란
changeType

enum (ChangeType)

색인 변경 방법을 지정합니다.

index

object (Index)

변경 중인 색인입니다.

색인

Cloud Firestore 색인을 사용하면 데이터베이스의 문서에 대한 단순 쿼리와 복잡한 쿼리를 사용할 수 있습니다.

JSON 표현
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
입력란
name

string

출력 전용. 이 색인의 서버 정의 이름입니다. 복합 색인의 경우 이름 형식은 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}입니다. 단일 필드 색인의 경우 이 필드는 비어 있습니다.

queryScope

enum (QueryScope)

컬렉션 쿼리 범위가 지정된 색인을 사용하면 특정 문서의 하위 요소이고 쿼리 시 지정되었으며 컬렉션 ID가 동일한 컬렉션에 대한 쿼리를 사용할 수 있습니다.

컬렉션 그룹 쿼리 범위가 지정된 색인은 쿼리 시 지정된 특정 문서의 하위 컬렉션이며 이 색인과 컬렉션 ID가 동일한 모든 컬렉션에 대한 쿼리를 허용합니다.

apiScope

enum (ApiScope)

이 색인에서 지원하는 API 범위입니다.

fields[]

object (IndexField)

이 색인에서 지원하는 필드입니다.

복합 색인의 경우 최소 2개에서 최대 100개의 필드가 필요합니다. 마지막 필드 항목은 항상 필드 경로 __name__에 대한 것입니다. 생성 시 __name__을 마지막 필드로 지정하지 않은 경우, 마지막으로 정의된 필드의 방향과 같은 방향으로 자동 추가됩니다. 복합 색인의 마지막 필드가 방향이 아니면 __name__는 명시적으로 지정되지 않는 한 ASCENDING으로 정렬됩니다.

단일 필드 색인의 경우 항상 연결된 필드의 필드 경로와 동일한 필드 경로를 갖는 정확히 하나의 항목이 됩니다.

state

enum (State)

출력 전용. 색인의 제공 상태입니다.

IndexField

색인의 필드입니다. fieldPath는 색인이 생성되는 필드를 설명하고 value_mode는 필드 값의 색인이 생성되는 방식을 설명합니다.

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.
}
입력란
fieldPath

string

name일 수 있습니다. 단일 필드 색인의 경우 필드 이름과 일치해야 하며, 그렇지 않으면 생략할 수 있습니다.

통합 필드 value_mode. 필드 값의 색인이 생성되는 방식입니다. value_mode은 다음 중 하나여야 합니다.
order

enum (Order)

이 필드가 지정된 순서에 따른 정렬이나 =, !=, <, <=, >, >=를 사용한 비교를 지원함을 나타냅니다.

arrayConfig

enum (ArrayConfig)

이 필드가 arrayValue의 작업을 지원함을 나타냅니다.

vectorConfig

object (VectorConfig)

이 필드가 벡터에서 최근접 이웃과 거리 연산을 지원함을 나타냅니다.

VectorConfig

벡터 검색 작업을 지원하는 색인 구성

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.
}
입력란
dimension

integer

필수 항목입니다. 이 구성이 적용되는 벡터 크기입니다.

결과 색인에는 이 차원의 벡터만 포함되며, 동일한 차원의 벡터 검색에 사용할 수 있습니다.

통합 필드 type. 사용된 색인 유형입니다. type은 다음 중 하나여야 합니다.
flat

object (FlatIndex)

벡터 색인이 단순 색인임을 나타냅니다.

FlatIndex

이 유형에는 필드가 없습니다.

플랫 데이터 구조에 벡터를 저장하고 전체 검색을 지원하는 색인입니다.

TtlConfigDelta

TTL 구성 변경에 관한 정보입니다.

JSON 표현
{
  "changeType": enum (ChangeType)
}
입력란
changeType

enum (ChangeType)

TTL 구성이 변경되는 방식을 지정합니다.