REST Resource: projects.databases.collectionGroups.fields

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

string

필수 항목입니다. projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} 형식의 필드 이름

필드 경로는 간단한 필드 이름(예: address)이거나 mapValue 내의 필드 경로(예: address.city)이거나 특수 필드 경로일 수 있습니다. 유일하게 유효한 특수 필드는 모든 필드를 나타내는 *입니다.

필드 경로는 (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),[,]` 및 ASCII 기호 문자를 사용하여 따옴표로 묶을 수 있습니다.

예: (참고: 여기서 주석은 마크다운 구문으로 작성되므로 코드 블록을 나타내기 위한 백틱 레이어가 추가로 있음) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`가 아닌 일반 필드입니다.

특수 Field에는 모든 필드의 기본 색인 생성 설정이 포함됩니다. 이 필드의 리소스 이름: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* 이 Field에 정의된 색인이 자체 Field 색인 구성이 없는 모든 필드에 적용됩니다.

object (IndexConfig)

이 필드의 색인 구성입니다. 설정하지 않으면 필드 색인 생성이 ancestorField에서 정의한 구성으로 되돌아갑니다. 이 필드의 모든 색인을 명시적으로 삭제하려면 빈 색인 목록을 사용하여 색인 구성을 지정하세요.

object (TtlConfig)

이 Field의 TTL 구성입니다. 이를 설정하거나 설정 해제하면 이 Field이(가) 있는 문서의 TTL이 사용 설정 또는 사용 중지됩니다.

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

object (Index)

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

boolean

출력 전용. true인 경우 Field의 색인 구성은 ancestorField에서 지정된 구성에서 설정됩니다. false인 경우 Field의 색인 구성이 명시적으로 정의됩니다.

string

출력 전용. 이 필드의 색인 구성이 설정되거나 (usesAncestorConfig가 true인 경우) 또는 이 필드에 색인 구성이 없는 경우 (usesAncestorConfig가 false인 경우) 설정될 Field의 리소스 이름을 지정합니다.

boolean

출력 전용: true인 경우 Field의 색인 구성을 되돌리는 중입니다. 완료되면 색인 구성은 ancestorField로 지정된 필드와 동일한 상태로 전환됩니다. 이때 usesAncestorConfig는 true, reverting는 false가 됩니다.

{
  "state": enum (State)
}

enum (State)

출력 전용. TTL 구성 상태입니다.