리소스: 필드
데이터베이스의 단일 필드를 나타냅니다.
필드는 데이터베이스의 ID가 동일한 모든 컬렉션을 나타내는 '컬렉션 그룹'을 기준으로 그룹화됩니다.
JSON 표현 |
---|
{ "name": string, "indexConfig": { object ( |
입력란 | |
---|---|
name |
필수 항목입니다. 필드 경로는 간단한 필드 이름(예: 필드 경로는 예: (참고: 여기서 주석은 마크다운 구문으로 작성되므로 코드 블록을 나타내기 위한 백틱 레이어가 추가로 있음) 특수 |
indexConfig |
이 필드의 색인 구성입니다. 설정하지 않으면 필드 색인 생성이 |
ttlConfig |
이 |
IndexConfig
이 필드의 색인 구성입니다.
JSON 표현 |
---|
{
"indexes": [
{
object ( |
입력란 | |
---|---|
indexes[] |
이 필드에 지원되는 색인입니다. |
usesAncestorConfig |
출력 전용. true인 경우 |
ancestorField |
출력 전용. 이 필드의 색인 구성이 설정되거나 ( |
reverting |
출력 전용: true인 경우 |
TtlConfig
이 Field
가 설정된 문서의 TTL (수명) 구성입니다.
TTL이 사용 설정된 필드에 타임스탬프 값을 저장하면 문서의 절대 만료 시간으로 처리됩니다. 과거의 타임스탬프 값은 문서가 즉시 만료될 수 있음을 나타냅니다. 다른 데이터 유형을 사용하거나 필드를 비워 두면 개별 문서의 만료가 사용 중지됩니다.
JSON 표현 |
---|
{
"state": enum ( |
입력란 | |
---|---|
state |
출력 전용. TTL 구성 상태입니다. |
상태
모든 문서에 TTL 구성을 적용한 상태입니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
상태가 지정되지 않았거나 알 수 없습니다. |
CREATING |
TTL을 적용하는 중입니다. 변경사항을 추적하는 활성 장기 실행 작업이 있습니다. 새로 작성된 문서에는 요청대로 TTL이 적용됩니다. 기존 문서에 요청된 TTL을 아직 처리하는 중입니다. 모든 기존 문서의 TTL이 처리되면 상태가 'ACTIVE'로 변경됩니다. |
ACTIVE |
TTL은 모든 문서에 대해 활성화됩니다. |
NEEDS_REPAIR |
일부 기존 문서에 TTL 구성을 사용 설정할 수 없습니다. 새로 작성된 문서에는 TTL이 계속 적용됩니다. 이 Field 에 TTL을 마지막으로 사용 설정하려고 시도했을 때 반환된 LRO가 실패했으며, 자세한 내용이 포함될 수 있습니다. |
방법 |
|
---|---|
|
필드의 메타데이터 및 구성을 가져옵니다. |
|
이 데이터베이스의 필드 구성 및 메타데이터를 나열합니다. |
|
필드 구성을 업데이트합니다. |