색인
FirestoreAdmin
(인터페이스)Backup
(메시지)Backup.State
(열거형)BackupSchedule
(메시지)CreateBackupScheduleRequest
(메시지)CreateDatabaseMetadata
(메시지)CreateDatabaseRequest
(메시지)CreateIndexRequest
(메시지)DailyRecurrence
(메시지)Database
(메시지)Database.AppEngineIntegrationMode
(열거형)Database.CmekConfig
(메시지)Database.ConcurrencyMode
(열거형)Database.DatabaseType
(열거형)Database.DeleteProtectionState
(열거형)Database.PointInTimeRecoveryEnablement
(열거형)DeleteBackupRequest
(메시지)DeleteBackupScheduleRequest
(메시지)DeleteDatabaseMetadata
(메시지)DeleteDatabaseRequest
(메시지)DeleteIndexRequest
(메시지)ExportDocumentsMetadata
(메시지)ExportDocumentsRequest
(메시지)ExportDocumentsResponse
(메시지)Field
(메시지)Field.IndexConfig
(메시지)Field.TtlConfig
(메시지)Field.TtlConfig.State
(열거형)FieldOperationMetadata
(메시지)FieldOperationMetadata.IndexConfigDelta
(메시지)FieldOperationMetadata.IndexConfigDelta.ChangeType
(열거형)FieldOperationMetadata.TtlConfigDelta
(메시지)FieldOperationMetadata.TtlConfigDelta.ChangeType
(열거형)GetBackupRequest
(메시지)GetBackupScheduleRequest
(메시지)GetDatabaseRequest
(메시지)GetFieldRequest
(메시지)GetIndexRequest
(메시지)ImportDocumentsMetadata
(메시지)ImportDocumentsRequest
(메시지)Index
(메시지)Index.ApiScope
(열거형)Index.IndexField
(메시지)Index.IndexField.ArrayConfig
(열거형)Index.IndexField.Order
(열거형)Index.IndexField.VectorConfig
(메시지)Index.IndexField.VectorConfig.FlatIndex
(메시지)Index.QueryScope
(열거형)Index.State
(열거형)IndexOperationMetadata
(메시지)ListBackupSchedulesRequest
(메시지)ListBackupSchedulesResponse
(메시지)ListBackupsRequest
(메시지)ListBackupsResponse
(메시지)ListDatabasesRequest
(메시지)ListDatabasesResponse
(메시지)ListFieldsRequest
(메시지)ListFieldsResponse
(메시지)ListIndexesRequest
(메시지)ListIndexesResponse
(메시지)LocationMetadata
(메시지)OperationState
(열거형)Progress
(메시지)RestoreDatabaseMetadata
(메시지)RestoreDatabaseRequest
(메시지)UpdateBackupScheduleRequest
(메시지)UpdateDatabaseMetadata
(메시지)UpdateDatabaseRequest
(메시지)UpdateFieldRequest
(메시지)WeeklyRecurrence
(메시지)
Firestore관리자
Cloud Firestore Admin API입니다.
이 API는 Cloud Firestore를 위한 여러 관리 서비스를 제공합니다.
Google Cloud Firestore API에 정의된 대로 프로젝트, 데이터베이스, 네임스페이스, 컬렉션, 컬렉션 그룹, 문서가 사용됩니다.
작업: Operation은 백그라운드에서 수행 중인 작업을 나타냅니다.
색인 서비스는 Cloud Firestore 색인을 관리합니다.
색인 생성은 비동기식으로 수행됩니다. 이러한 비동기 작업마다 Operation 리소스가 생성됩니다. 작업 상태 (발생한 오류 포함)는 작업 리소스를 통해 쿼리할 수 있습니다.
작업 컬렉션은 지정된 프로젝트 (진행 중인 작업 포함)에 대해 수행된 작업 기록을 제공합니다. 작업은 직접 생성되지 않고 다른 컬렉션 또는 리소스의 호출을 통해 생성됩니다.
완료된 작업은 삭제되어 더 이상 작업 모음에 포함되지 않도록 삭제할 수 있습니다. 작업은 30일 후에 가비지로 수집됩니다. 기본적으로 ListOperations는 진행 중인 작업과 실패한 작업만 반환합니다. 완료된 작업을 나열하려면 done: true
필터를 사용하여 ListOperations 요청을 실행합니다.
작업은 FirestoreAdmin
서비스에서 생성되지만 google.longrunning.Operations
서비스를 통해 액세스합니다.
백업 일정 만들기 |
---|
데이터베이스에 백업 일정을 만듭니다. 데이터베이스에서는 일일 백업 일정 1개와 주간 백업 일정 1개 등 최대 2개의 백업 일정을 구성할 수 있습니다.
|
데이터베이스 만들기 |
---|
데이터베이스 만들기
|
CreateIndex |
---|
복합 색인을 만듭니다. 이렇게 하면 생성 상태를 추적하는 데 사용할 수 있는
|
DeleteBackup |
---|
백업을 삭제합니다.
|
백업 일정 삭제 |
---|
백업 일정을 삭제합니다.
|
데이터베이스 삭제 |
---|
데이터베이스를 삭제합니다.
|
DeleteIndex |
---|
복합 색인을 삭제합니다.
|
문서 내보내기 |
---|
Google Cloud Firestore의 문서 전체 또는 하위 집합을 Google Cloud Storage와 같은 다른 스토리지 시스템으로 내보냅니다. 문서의 최근 업데이트가 내보내기에 반영되지 않을 수 있습니다. 내보내기는 백그라운드에서 실행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. 내보내기의 출력은 연결된 작업이 완료된 후에만 사용할 수 있습니다. 내보내기 작업이 완료 전에 취소되면 Google Cloud Storage에 일부 데이터가 남을 수 있습니다. 내보내기 동작 및 출력 형식에 대한 자세한 내용은 https://cloud.google.com/firestore/docs/manage-data/export-import를 참조하세요.
|
GetBackup |
---|
백업 정보를 가져옵니다.
|
백업 일정 가져오기 |
---|
백업 일정에 대한 정보를 가져옵니다.
|
데이터베이스 가져오기 |
---|
데이터베이스에 대한 정보를 가져옵니다.
|
필드 가져오기 |
---|
필드의 메타데이터 및 구성을 가져옵니다.
|
GetIndex |
---|
복합 색인을 가져옵니다.
|
문서 가져오기 |
---|
문서를 Google Cloud Firestore로 가져옵니다. 이름이 같은 기존 문서를 덮어씁니다. 가져오기는 백그라운드에서 실행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. ImportDocuments 작업이 취소된 경우, 데이터의 하위 집합을 이미 Cloud Firestore로 가져왔을 수 있습니다.
|
ListBackupSchedules |
---|
백업 일정을 나열합니다.
|
ListBackups |
---|
모든 백업을 나열합니다.
|
데이터베이스 나열 |
---|
프로젝트의 모든 데이터베이스를 나열합니다.
|
목록필드 |
---|
이 데이터베이스의 필드 구성 및 메타데이터를 나열합니다. 현재
|
ListIndex |
---|
복합 색인을 나열합니다.
|
데이터베이스 복원 |
---|
기존 백업에서 복원하여 새 데이터베이스를 만듭니다. 새 데이터베이스는 기존 백업과 동일한 클라우드 리전 또는 멀티 리전 위치에 있어야 합니다. 이는 [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] 와 유사하게 동작하지만, 비어 있는 데이터베이스를 새로 만드는 대신 데이터베이스 유형, 색인 구성, 기존 백업의 문서로 새 데이터베이스가 생성됩니다.
|
UpdateBackupSchedule(백업 일정) |
---|
백업 일정을 업데이트합니다.
|
데이터베이스 업데이트 |
---|
데이터베이스를 업데이트합니다.
|
업데이트입력란 |
---|
필드 구성을 업데이트합니다. 현재 필드 업데이트는 단일 필드 색인 구성에만 적용됩니다. 그러나 이 호출은 필드 업데이트의 상태를 추적하는 데 사용할 수 있는 데이터베이스의 기본 필드 설정을 구성하려면 리소스 이름이
|
백업
Cloud Firestore 데이터베이스의 백업
백업에는 특정 시점에 지정된 데이터베이스의 모든 문서와 색인 구성이 포함됩니다.
필드 | |
---|---|
name |
출력 전용입니다. 백업의 고유한 리소스 이름입니다. 형식은 |
database |
출력 전용입니다. 백업이 시작된 Firestore 데이터베이스의 이름입니다. 형식은 |
database_uid |
출력 전용입니다. 백업이 시작된 Firestore 데이터베이스의 시스템 생성 UUID4입니다. |
snapshot_time |
출력 전용입니다. 현재 백업에는 외부에서 일관된 데이터베이스 사본이 포함됩니다. |
expire_time |
출력 전용입니다. 이 백업이 만료되는 타임스탬프입니다. |
state |
출력 전용입니다. 백업의 현재 상태입니다. |
상태
백업의 현재 상태를 나타냅니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
상태가 지정되지 않았습니다. |
CREATING |
대기 중인 백업을 아직 만드는 중입니다. 이 상태에서는 백업 작업이 거부됩니다. |
READY |
백업이 완료되어 사용할 준비가 되었습니다. |
NOT_AVAILABLE |
지금은 백업을 사용할 수 없습니다. |
백업 일정
Cloud Firestore 데이터베이스의 백업 일정입니다.
이 리소스는 백업 중인 데이터베이스가 소유하며 데이터베이스와 함께 삭제됩니다. 하지만 실제 백업은 그렇지 않습니다.
필드 | |
---|---|
name |
출력 전용입니다. 지정된 프로젝트의 모든 위치 및 데이터베이스에서 고유한 백업 일정 식별자입니다. 자동으로 할당됩니다. 형식은 |
create_time |
출력 전용입니다. 이 백업 일정이 생성되어 유효한 타임스탬프입니다. 이 시간 전에는 이 일정에 대한 백업이 생성되지 않습니다. |
update_time |
출력 전용입니다. 이 백업 일정이 가장 최근에 업데이트된 타임스탬프입니다. 백업 일정을 처음 만들 때는 create_time과 동일합니다. |
retention |
생성 시간과 비교한 미래의 상대적 시점(예: 백업 7일 동안)을 삭제해야 합니다. |
통합 필드 recurrence . 백업이 수행되는 시점을 나타내는 필드 중 하나입니다. recurrence 은 다음 중 하나여야 합니다. |
|
daily_recurrence |
매일 실행되는 일정에 사용됩니다. |
weekly_recurrence |
특정 요일에 매주 실행되는 일정 |
CreateBackupScheduleRequest -
필드 | |
---|---|
parent |
필수 항목입니다. 상위 데이터베이스입니다.
|
backup_schedule |
필수 항목입니다. 생성할 백업 일정입니다. |
CreateDatabaseMetadata
이 유형에는 필드가 없습니다.
데이터베이스 만들기 작업과 관련된 메타데이터입니다.
CreateDatabaseRequest
FirestoreAdmin.CreateDatabase
의 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. |
database |
필수 항목입니다. 생성할 데이터베이스입니다. |
database_id |
필수 항목입니다. 데이터베이스에 사용할 ID로, 데이터베이스 리소스 이름의 최종 구성요소가 됩니다. 이 값은 4~63자(영문 기준)여야 합니다. 유효한 문자는 /[a-z][0-9]-/ 이며 첫 문자는 문자, 마지막 글자는 문자 또는 숫자입니다. UUID와 같아서는 안 됩니다. /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. '(기본값)' 데이터베이스 ID도 유효합니다. |
CreateIndexRequest
FirestoreAdmin.CreateIndex
의 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. |
index |
필수 항목입니다. 만들 복합 색인입니다. |
일일 반복
이 유형에는 필드가 없습니다.
매일 실행되는 반복 일정을 나타냅니다.
시간대는 UTC입니다.
데이터베이스
Cloud Firestore 데이터베이스입니다.
필드 | |
---|---|
name |
데이터베이스의 리소스 이름입니다. 형식: |
uid |
출력 전용입니다. 이 데이터베이스의 시스템 생성 UUID4입니다. |
create_time |
출력 전용입니다. 이 데이터베이스가 생성된 타임스탬프입니다. 2016년 이전에 생성된 데이터베이스에는 create_time이 채워지지 않습니다. |
update_time |
출력 전용입니다. 이 데이터베이스가 가장 최근에 업데이트된 타임스탬프입니다. 여기에는 데이터베이스 리소스의 업데이트만 포함되며 데이터베이스에 포함된 데이터는 포함되지 않습니다. |
delete_time |
출력 전용입니다. 이 데이터베이스가 삭제된 타임스탬프입니다. 데이터베이스가 삭제된 경우에만 설정됩니다. |
location_id |
데이터베이스의 위치입니다. 사용 가능한 위치는 https://cloud.google.com/firestore/docs/locations에서 확인할 수 있습니다. |
type |
데이터베이스의 유형입니다. 선택 방법에 대한 자세한 내용은 https://cloud.google.com/datastore/docs/firestore-or-datastore를 참조하세요. |
concurrency_mode |
이 데이터베이스에 사용할 동시 실행 제어 모드입니다. |
version_retention_period |
출력 전용입니다. 이전 버전의 데이터가 데이터베이스에 보관되는 기간입니다. 모든 PITR 기능이 사용 설정된 경우 보관 기간은 7일입니다. 그렇지 않은 경우 보관 기간은 1시간입니다. |
earliest_version_time |
출력 전용입니다. 데이터베이스에서 이전 버전의 데이터를 읽을 수 있는 가장 이른 타임스탬프입니다. 위의 [version_retention_period] 를 참고하세요. 이 필드는 이 값은 지속적으로 업데이트되며 쿼리되는 즉시 오래된 상태가 됩니다. 이 값을 사용하여 데이터를 복구하는 경우, 값이 쿼리된 순간부터 복구를 시작하는 순간까지의 기간을 고려해야 합니다. |
point_in_time_recovery_enablement |
이 데이터베이스에서 PITR 기능을 사용 설정할지 여부입니다. |
app_engine_integration_mode |
이 데이터베이스에 사용할 App Engine 통합 모드입니다. |
key_prefix |
출력 전용입니다. 이 데이터베이스의 key_prefix입니다. 이 key_prefix는 프로젝트 ID (' URL 인코딩 키에 사용할 appid가 project_id인 경우에는 이 값이 비어 있을 수 있습니다 (예: v~foo 대신 foo). |
delete_protection_state |
데이터베이스의 삭제 보호 상태입니다. |
cmek_config |
선택사항입니다. 존재는 이 데이터베이스에 CMEK가 사용 설정되었음을 나타냅니다. |
previous_id |
출력 전용입니다. 데이터베이스 리소스의 이전 데이터베이스 ID입니다. 이 필드는 삭제된 데이터베이스에 대해서만 채워집니다. |
etag |
이 체크섬은 서버에서 다른 필드의 값을 기반으로 계산되며, 업데이트 및 삭제 요청 시 전송되기 전에 클라이언트가 최신 값을 유지하도록 할 수 있습니다. |
AppEngineIntegrationMode
App Engine 통합 모드의 유형입니다.
열거형 | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
사용되지 않음. |
ENABLED |
App Engine 애플리케이션이 이 데이터베이스와 동일한 리전에 있으면 App Engine 구성이 이 데이터베이스에 영향을 줍니다. 여기에는 애플리케이션 및 데이터베이스 사용 중지와 데이터베이스 쓰기 사용 중지가 포함됩니다. |
DISABLED |
App Engine은 이 데이터베이스의 요청 처리 기능에 영향을 미치지 않습니다. Firestore API로 만든 데이터베이스의 기본 설정입니다. |
CmekConfig
Firestore 데이터베이스의 CMEK (고객 관리 암호화 키) 구성입니다. 없는 경우 데이터베이스는 기본 Google 암호화 키로 보호됩니다.
필드 | |
---|---|
kms_key_name |
필수 항목입니다. 이 데이터베이스와 동일한 위치에 있는 키만 암호화에 사용할 수 있습니다. Firestore의 nam5 멀티 리전의 경우 Cloud KMS 멀티 리전 us에 해당합니다. Firestore의 eur3 멀티 리전의 경우 Cloud KMS 멀티 리전 유럽에 해당합니다. https://cloud.google.com/kms/docs/locations를 참조하세요. 올바른 형식은 |
active_key_version[] |
출력 전용입니다. 현재 사용 중인 KMS 키 버전 키 순환 중에 사용 중인 키 버전이 여러 개 있을 수 있습니다. 올바른 형식은 |
ConcurrencyMode
트랜잭션의 동시 실행 제어 모드 유형입니다.
열거형 | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
사용되지 않음. |
OPTIMISTIC |
기본적으로 낙관적 동시 실행 제어를 사용합니다. Cloud Firestore 데이터베이스에 이 모드를 사용할 수 있습니다. |
PESSIMISTIC |
기본적으로 비관적 동시 실행 제어를 사용합니다. Cloud Firestore 데이터베이스에 이 모드를 사용할 수 있습니다. 이는 Cloud Firestore의 기본 설정입니다. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
기본적으로 항목 그룹과 함께 낙관적 동시 실행 제어를 사용합니다. Cloud Datastore에 사용할 수 있는 유일한 모드입니다. 이 모드는 Datastore 모드의 Cloud Firestore에도 사용할 수 있지만 권장되지 않습니다. |
DatabaseType
데이터베이스의 유형입니다. 선택 방법에 대한 자세한 내용은 https://cloud.google.com/datastore/docs/firestore-or-datastore를 참조하세요.
데이터베이스가 비어 있는 경우에만 모드를 변경할 수 있습니다.
열거형 | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
기본값입니다. 데이터베이스 유형이 생략된 경우 이 값이 사용됩니다. |
FIRESTORE_NATIVE |
Firestore Native 모드 |
DATASTORE_MODE |
Datastore 모드의 Firestore |
DeleteProtectionState(삭제 보호 상태)
데이터베이스의 삭제 보호 상태입니다.
열거형 | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
기본값입니다. 삭제 보호 유형이 지정되지 않았습니다. |
DELETE_PROTECTION_DISABLED |
삭제 보호가 사용 중지되었습니다. |
DELETE_PROTECTION_ENABLED |
삭제 보호가 사용 설정되었습니다. |
PointInTimeRecoveryEnablement
PITR(point-in-time recovery) 기능 사용 설정
열거형 | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
사용되지 않음. |
POINT_IN_TIME_RECOVERY_ENABLED |
읽기는 지난 7일 이내의 선택한 데이터 버전에서 지원됩니다.
|
POINT_IN_TIME_RECOVERY_DISABLED |
읽기는 지난 1시간 이내의 모든 버전의 데이터에 지원됩니다. |
DeleteBackupRequest
FirestoreAdmin.DeleteBackup
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 백업의 이름입니다. 형식은 |
DeleteBackupScheduleRequest
[FirestoreAdmin.DeleteBackupSchedules][] 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 백업 일정의 이름입니다.
|
DeleteDatabaseMetadata
이 유형에는 필드가 없습니다.
데이터베이스 삭제 작업과 관련된 메타데이터입니다.
데이터베이스 삭제 요청
FirestoreAdmin.DeleteDatabase
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
etag |
데이터베이스의 현재 etag입니다. etag가 제공되지만 데이터베이스의 현재 etag와 일치하지 않으면 삭제가 차단되고 FAILED_PRECONDITION 오류가 반환됩니다. |
DeleteIndexRequest
FirestoreAdmin.DeleteIndex
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
ExportDocumentsMetadata
FirestoreAdmin.ExportDocuments
에서 검색한 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time |
이 작업이 시작된 시간입니다. |
end_time |
이 작업이 완료된 시간입니다. 작업이 계속 진행 중이면 설정되지 않습니다. |
operation_state |
내보내기 작업의 상태입니다. |
progress_documents |
문서 내 이 작업의 진행 상황입니다. |
progress_bytes |
이 작업의 진행률(바이트)입니다. |
collection_ids[] |
내보내는 컬렉션 ID입니다. |
output_uri_prefix |
문서를 내보낼 위치 |
namespace_ids[] |
내보내는 네임스페이스 ID입니다. |
snapshot_time |
내보낼 데이터베이스의 버전에 해당하는 타임스탬프입니다. 지정하지 않으면 내보내는 문서의 일관성이 보장되지 않습니다. |
ExportDocumentsRequest
FirestoreAdmin.ExportDocuments
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 내보낼 데이터베이스입니다. |
collection_ids[] |
내보낼 컬렉션 ID입니다. 지정되지 않음은 모든 컬렉션을 의미합니다. |
output_uri_prefix |
출력 URI입니다. 현재 |
namespace_ids[] |
빈 목록은 모든 네임스페이스를 나타냅니다. 네임스페이스를 사용하지 않는 데이터베이스의 경우 선호되는 방식입니다. 빈 문자열 요소는 기본 네임스페이스를 나타냅니다. 이 옵션은 데이터베이스에 기본이 아닌 네임스페이스에 데이터가 있지만 포함하지 않으려는 경우에 사용해야 합니다. 이 목록의 각 네임스페이스는 고유해야 합니다. |
snapshot_time |
내보낼 데이터베이스의 버전에 해당하는 타임스탬프입니다. 타임스탬프는 과거여야 하며 분으로 반올림되어야 하며 |
ExportDocumentsResponse
google.longrunning.Operation
응답 필드에 반환됩니다.
필드 | |
---|---|
output_uri_prefix |
출력 파일의 위치입니다. 작업이 성공적으로 완료된 후 Cloud Firestore (이 프로젝트 또는 다른 프로젝트)로 가져오기를 시작하는 데 사용할 수 있습니다. |
필드
데이터베이스의 단일 필드를 나타냅니다.
필드는 데이터베이스의 ID가 동일한 모든 컬렉션을 나타내는 '컬렉션 그룹'을 기준으로 그룹화됩니다.
필드 | |
---|---|
name |
필수 항목입니다. 필드 경로는 간단한 필드 이름(예: 필드 경로는 예: (참고: 여기서 주석은 마크다운 구문으로 작성되므로 코드 블록을 나타내기 위한 백틱 레이어가 추가로 있음) 특수 |
index_config |
이 필드의 색인 구성입니다. 설정하지 않으면 필드 색인 생성이 |
ttl_config |
이 |
색인 구성
이 필드의 색인 구성입니다.
필드 | |
---|---|
indexes[] |
이 필드에 지원되는 색인입니다. |
uses_ancestor_config |
출력 전용입니다. true인 경우 |
ancestor_field |
출력 전용입니다. 이 필드의 색인 구성이 설정되거나 ( |
reverting |
출력 전용: true인 경우 |
TTL 구성
이 Field
가 설정된 문서의 TTL (수명) 구성입니다.
TTL이 사용 설정된 필드에 타임스탬프 값을 저장하면 문서의 절대 만료 시간으로 처리됩니다. 과거의 타임스탬프 값은 문서가 즉시 만료될 수 있음을 나타냅니다. 다른 데이터 유형을 사용하거나 필드를 비워 두면 개별 문서의 만료가 사용 중지됩니다.
필드 | |
---|---|
state |
출력 전용입니다. TTL 구성 상태입니다. |
상태
모든 문서에 TTL 구성을 적용한 상태입니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
상태가 지정되지 않았거나 알 수 없습니다. |
CREATING |
TTL을 적용하는 중입니다. 변경사항을 추적하는 활성 장기 실행 작업이 있습니다. 새로 작성된 문서에는 요청대로 TTL이 적용됩니다. 기존 문서에 요청된 TTL을 아직 처리하는 중입니다. 모든 기존 문서의 TTL이 처리되면 상태가 'ACTIVE'로 변경됩니다. |
ACTIVE |
TTL은 모든 문서에 대해 활성화됩니다. |
NEEDS_REPAIR |
일부 기존 문서에 TTL 구성을 사용 설정할 수 없습니다. 새로 작성된 문서에는 TTL이 계속 적용됩니다. 이 Field 에 TTL을 마지막으로 사용 설정하려고 시도했을 때 반환된 LRO가 실패했으며, 자세한 내용이 포함될 수 있습니다. |
FieldOperationMetadata
FirestoreAdmin.UpdateField
에서 검색한 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time |
이 작업이 시작된 시간입니다. |
end_time |
이 작업이 완료된 시간입니다. 작업이 계속 진행 중이면 설정되지 않습니다. |
field |
이 작업이 작동하는 필드 리소스입니다. 예: |
index_config_deltas[] |
이 작업의 인텐트를 설명하는 |
state |
작업의 상태입니다. |
progress_documents |
문서 내 이 작업의 진행 상황입니다. |
progress_bytes |
이 작업의 진행률(바이트)입니다. |
ttl_config_delta |
TTL 구성의 델타를 설명합니다. |
색인 구성 델타
색인 구성 변경에 대한 정보입니다.
필드 | |
---|---|
change_type |
색인 변경 방법을 지정합니다. |
index |
변경 중인 색인입니다. |
ChangeType
색인 변경 방법을 지정합니다.
열거형 | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
변경 유형이 지정되지 않았거나 알려지지 않았습니다. |
ADD |
단일 필드 색인을 추가하는 중입니다. |
REMOVE |
단일 필드 색인을 삭제하는 중입니다. |
TtlConfigDelta
TTL 구성 변경에 관한 정보입니다.
필드 | |
---|---|
change_type |
TTL 구성이 변경되는 방식을 지정합니다. |
ChangeType
TTL 구성 변경 방식을 지정합니다.
열거형 | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
변경 유형이 지정되지 않았거나 알려지지 않았습니다. |
ADD |
TTL 구성을 추가하는 중입니다. |
REMOVE |
TTL 구성을 삭제하는 중입니다. |
GetBackupRequest
FirestoreAdmin.GetBackup
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 가져올 백업의 이름입니다. 형식은 |
GetBackupScheduleRequest
FirestoreAdmin.GetBackupSchedule
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 백업 일정의 이름입니다.
|
GetDatabaseRequest
FirestoreAdmin.GetDatabase
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
GetFieldRequest
FirestoreAdmin.GetField
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
GetIndexRequest
FirestoreAdmin.GetIndex
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
ImportDocumentsMetadata
FirestoreAdmin.ImportDocuments
에서 검색한 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time |
이 작업이 시작된 시간입니다. |
end_time |
이 작업이 완료된 시간입니다. 작업이 계속 진행 중이면 설정되지 않습니다. |
operation_state |
가져오기 작업의 상태입니다. |
progress_documents |
문서 내 이 작업의 진행 상황입니다. |
progress_bytes |
이 작업의 진행률(바이트)입니다. |
collection_ids[] |
가져오는 컬렉션 ID입니다. |
input_uri_prefix |
가져오는 문서의 위치입니다. |
namespace_ids[] |
가져오는 네임스페이스 ID입니다. |
ImportDocumentsRequest
FirestoreAdmin.ImportDocuments
의 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 가져올 데이터베이스입니다. |
collection_ids[] |
가져올 컬렉션 ID입니다. 지정되지 않음은 가져오기에 포함된 모든 컬렉션을 의미합니다. |
input_uri_prefix |
내보낸 파일의 위치입니다. 성공적으로 완료된 내보내기의 ExportDocumentsResponse의 output_uri_prefix와 일치해야 합니다. |
namespace_ids[] |
빈 목록은 모든 네임스페이스를 나타냅니다. 네임스페이스를 사용하지 않는 데이터베이스의 경우 선호되는 방식입니다. 빈 문자열 요소는 기본 네임스페이스를 나타냅니다. 이 옵션은 데이터베이스에 기본이 아닌 네임스페이스에 데이터가 있지만 포함하지 않으려는 경우에 사용해야 합니다. 이 목록의 각 네임스페이스는 고유해야 합니다. |
색인
Cloud Firestore 색인을 사용하면 데이터베이스의 문서에 대한 단순 쿼리와 복잡한 쿼리를 사용할 수 있습니다.
필드 | |
---|---|
name |
출력 전용입니다. 이 색인의 서버 정의 이름입니다. 복합 색인의 경우 이름 형식은 |
query_scope |
컬렉션 쿼리 범위가 지정된 색인을 사용하면 특정 문서의 하위 요소이고 쿼리 시 지정되었으며 컬렉션 ID가 동일한 컬렉션에 대한 쿼리를 사용할 수 있습니다. 컬렉션 그룹 쿼리 범위가 지정된 색인은 쿼리 시 지정된 특정 문서의 하위 컬렉션이며 이 색인과 컬렉션 ID가 동일한 모든 컬렉션에 대한 쿼리를 허용합니다. |
api_scope |
이 색인에서 지원하는 API 범위입니다. |
fields[] |
이 색인에서 지원하는 필드입니다. 복합 색인의 경우 최소 2개에서 최대 100개의 필드가 필요합니다. 마지막 필드 항목은 항상 필드 경로 단일 필드 색인의 경우 항상 연결된 필드의 필드 경로와 동일한 필드 경로를 갖는 정확히 하나의 항목이 됩니다. |
state |
출력 전용입니다. 색인의 제공 상태입니다. |
ApiScope
API 범위는 쿼리에 지원되는 API (Firestore Native 또는 Datastore 모드의 Firestore)를 정의합니다.
열거형 | |
---|---|
ANY_API |
색인은 Firestore Native Query API에서만 사용할 수 있습니다. 전역 window는 기본 설정이며, |
DATASTORE_MODE_API |
이 색인은 Datastore 모드의 Firestore 쿼리 API에서만 사용할 수 있습니다. |
색인 필드
색인의 필드입니다. field_path는 색인이 생성되는 필드를 설명하고 value_mode는 필드 값의 색인이 생성되는 방식을 설명합니다.
필드 | |
---|---|
field_path |
name일 수 있습니다. 단일 필드 색인의 경우 필드 이름과 일치해야 하며, 그렇지 않으면 생략할 수 있습니다. |
통합 필드 value_mode . 필드 값의 색인이 생성되는 방식입니다. value_mode 은 다음 중 하나여야 합니다. |
|
order |
이 필드가 지정된 순서에 따른 정렬이나 =, !=, <, <=, >, >=를 사용한 비교를 지원함을 나타냅니다. |
array_config |
이 필드가 |
vector_config |
이 필드가 벡터에서 최근접 이웃 및 거리 연산을 지원함을 나타냅니다. |
ArrayConfig
지원되는 배열 값 구성입니다.
열거형 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
색인은 추가 배열 쿼리를 지원하지 않습니다. |
CONTAINS |
색인은 배열 포함 쿼리를 지원합니다. |
주문
지원되는 순서입니다.
열거형 | |
---|---|
ORDER_UNSPECIFIED |
순서가 지정되지 않았습니다. 유효한 옵션이 아닙니다. |
ASCENDING |
필드는 필드 값의 오름차순으로 정렬됩니다. |
DESCENDING |
필드는 필드 값의 내림차순으로 정렬됩니다. |
벡터 구성
벡터 검색 작업을 지원하는 색인 구성
필드 | |
---|---|
dimension |
필수 항목입니다. 이 구성이 적용되는 벡터 크기입니다. 결과 색인에는 이 차원의 벡터만 포함되며, 동일한 차원의 벡터 검색에 사용할 수 있습니다. |
통합 필드 type . 사용된 색인 유형입니다. type 은 다음 중 하나여야 합니다. |
|
flat |
벡터 색인이 단순 색인임을 나타냅니다. |
플랫 색인
이 유형에는 필드가 없습니다.
플랫 데이터 구조에 벡터를 저장하고 전체 검색을 지원하는 색인입니다.
QueryScope
쿼리 범위는 쿼리가 실행되는 범위를 정의합니다. StructuredQuery의 from
필드에 지정됩니다.
열거형 | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
쿼리 범위가 지정되지 않았습니다. 유효한 옵션이 아닙니다. |
COLLECTION |
컬렉션 쿼리 범위가 지정된 색인은 쿼리 시 지정된 특정 문서의 하위 요소이고 색인으로 지정된 컬렉션 ID가 있는 컬렉션에 대한 쿼리를 허용합니다. |
COLLECTION_GROUP |
컬렉션 그룹 쿼리 범위가 지정된 색인은 색인으로 지정된 컬렉션 ID가 있는 모든 컬렉션에 대한 쿼리를 허용합니다. |
COLLECTION_RECURSIVE |
색인에 컬렉션의 모든 상위 항목을 포함합니다. Datastore 모드 데이터베이스에서만 사용할 수 있습니다. |
상태
색인의 상태입니다. 색인을 만드는 동안 색인은 CREATING
상태가 됩니다. 색인이 생성되면 READY
상태로 전환됩니다. 색인 생성에 문제가 발생하면 색인이 NEEDS_REPAIR
상태로 전환됩니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
상태가 지정되지 않았습니다. |
CREATING |
색인을 만드는 중입니다. 색인에 대한 활성 장기 실행 작업이 있습니다. 색인은 문서를 작성할 때 업데이트됩니다. 일부 색인 데이터가 있을 수 있습니다. |
READY |
색인을 사용할 준비가 되었습니다. 색인은 문서를 작성할 때 업데이트됩니다. 색인은 적용되는 모든 저장된 문서로부터 완전히 채워집니다. |
NEEDS_REPAIR |
색인을 생성 중이지만 문제가 발생했습니다. 색인에 대한 활성 장기 실행 작업이 없으며 가장 최근에 완료된 장기 실행 작업이 실패했습니다. 문서를 작성할 때는 색인이 업데이트되지 않습니다. 일부 색인 데이터가 있을 수 있습니다. google.longrunning.Operations API를 사용하여 마지막으로 이 색인을 만들려고 시도한 작업이 실패한 이유를 확인한 다음 색인을 다시 만듭니다. |
IndexOperationMetadata
FirestoreAdmin.CreateIndex
에서 검색한 google.longrunning.Operation
결과에 대한 메타데이터입니다.
필드 | |
---|---|
start_time |
이 작업이 시작된 시간입니다. |
end_time |
이 작업이 완료된 시간입니다. 작업이 계속 진행 중이면 설정되지 않습니다. |
index |
이 작업이 작동하는 색인 리소스입니다. 예: |
state |
작업의 상태입니다. |
progress_documents |
문서 내 이 작업의 진행 상황입니다. |
progress_bytes |
이 작업의 진행률(바이트)입니다. |
ListBackupSchedulesRequest
필드 | |
---|---|
parent |
필수 항목입니다. 상위 데이터베이스입니다. 형식은 |
ListBackupSchedules 응답
필드 | |
---|---|
backup_schedules[] |
모든 백업 일정 목록입니다. |
ListBackupsRequest
FirestoreAdmin.ListBackups
의 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 백업을 나열할 위치입니다. 형식은 |
ListBackupsResponse
FirestoreAdmin.ListBackups
의 응답입니다.
필드 | |
---|---|
backups[] |
프로젝트의 모든 백업 목록입니다. |
unreachable[] |
기존 백업을 가져올 수 없는 위치 목록입니다. 이 응답은 단일 위치에 연결할 수 없을 때 전체 요청을 실패하는 대신 부분 결과 집합과 여기에서 도달할 수 없는 위치 목록을 반환합니다. 단일 위치에서 요청을 재시도하여 구체적인 오류를 가져올 수 있습니다. |
ListDatabasesRequest
프로젝트의 모든 위치에 있는 Firestore 데이터베이스를 나열하기 위한 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. |
show_deleted |
true인 경우 삭제된 리소스도 반환합니다. |
ListDatabasesResponse
프로젝트의 데이터베이스 목록입니다.
필드 | |
---|---|
databases[] |
프로젝트의 데이터베이스입니다. |
unreachable[] |
개별 데이터베이스에 대한 데이터를 나열할 수 없는 경우에는 여기에 기록됩니다. 예시 항목은 다음과 같습니다. projects/some_project/locations/some_location, 데이터베이스가 있는 Cloud 리전을 현재 사용할 수 없는 경우에 발생할 수 있습니다. 이 경우 데이터베이스에 대한 모든 세부정보를 가져올 수 없습니다. 리소스에 대한 'Get' 요청 또는 특정 위치에 대한 'List' 요청을 전송하여 자세한 오류 메시지를 받거나 리소스를 가져올 수 있습니다. |
ListFieldsRequest
FirestoreAdmin.ListFields
의 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. |
filter |
목록 결과에 적용할 필터입니다. 현재 |
page_size |
반환할 결과 수입니다. |
page_token |
|
ListFields 응답
FirestoreAdmin.ListFields
의 응답입니다.
필드 | |
---|---|
fields[] |
요청된 필드입니다. |
next_page_token |
다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비어 있으면 이 페이지가 마지막 페이지입니다. |
ListIndexesRequest
FirestoreAdmin.ListIndexes
의 요청입니다.
필드 | |
---|---|
parent |
필수 항목입니다. |
filter |
목록 결과에 적용할 필터입니다. |
page_size |
반환할 결과 수입니다. |
page_token |
|
ListIndexes응답
FirestoreAdmin.ListIndexes
의 응답입니다.
필드 | |
---|---|
indexes[] |
요청된 색인입니다. |
next_page_token |
다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비어 있으면 이 페이지가 마지막 페이지입니다. |
LocationMetadata
이 유형에는 필드가 없습니다.
google.cloud.location.Location.metadata
의 메타데이터 메시지입니다.
OperationState
작업의 상태를 설명합니다.
열거형 | |
---|---|
OPERATION_STATE_UNSPECIFIED |
지정되지 않음. |
INITIALIZING |
요청 처리를 준비하는 중입니다. |
PROCESSING |
요청이 처리되고 있습니다. |
CANCELLING |
사용자가 작업에서 google.longrunning.Operations.CancelOperation을 호출한 후 요청이 취소되고 있습니다. |
FINALIZING |
요청이 처리되었으며 완료 단계에 있습니다. |
SUCCESSFUL |
요청이 완료되었습니다. |
FAILED |
요청 처리가 완료되었지만 오류가 발생했습니다. |
CANCELLED |
사용자가 google.longrunning.Operations.CancelOperation을 호출한 후 요청 취소가 완료되었습니다. |
진행률
작업의 진행 상황을 설명합니다. 작업 단위는 일반적이며 Progress
가 사용되는 위치에 따라 해석되어야 합니다.
필드 | |
---|---|
estimated_work |
예상 작업량입니다. |
completed_work |
완료된 작업의 양입니다. |
RestoreDatabaseMetadata
[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] 요청의 long-running operation
에 대한 메타데이터입니다.
필드 | |
---|---|
start_time |
복원이 시작된 시간입니다. |
end_time |
복원이 완료된 시간입니다. 진행 중인 복원의 경우에는 설정되지 않습니다. |
operation_state |
복원 작업 상태입니다. |
database |
복원될 데이터베이스의 이름입니다. |
backup |
복원하는 백업의 이름입니다. |
progress_percentage |
복원이 얼마나 진행된지를 남은 시간의 예상 비율로 나타낸 것입니다. |
RestoreDatabaseRequest
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]의 요청 메시지입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 데이터베이스를 복원할 프로젝트입니다. 형식은 |
database_id |
필수 항목입니다. 데이터베이스에 사용할 ID로, 데이터베이스 리소스 이름의 최종 구성요소가 됩니다. 이 데이터베이스 ID는 기존 데이터베이스와 연결될 수 없습니다. 이 값은 4~63자(영문 기준)여야 합니다. 유효한 문자는 /[a-z][0-9]-/ 이며 첫 문자는 문자, 마지막 글자는 문자 또는 숫자입니다. UUID와 같아서는 안 됩니다. /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. '(기본값)' 데이터베이스 ID도 유효합니다. |
통합 필드
|
|
backup |
복원할 백업입니다. 상위 프로젝트와 동일한 프로젝트에 속해야 합니다. 형식은 |
UpdateBackupScheduleRequest
필드 | |
---|---|
backup_schedule |
필수 항목입니다. 업데이트할 백업 일정입니다. |
update_mask |
업데이트할 필드의 목록입니다. |
UpdateDatabaseMetadata
이 유형에는 필드가 없습니다.
데이터베이스 업데이트 작업과 관련된 메타데이터입니다.
UpdateDatabaseRequest
FirestoreAdmin.UpdateDatabase
의 요청입니다.
필드 | |
---|---|
database |
필수 항목입니다. 업데이트할 데이터베이스입니다. |
update_mask |
업데이트할 필드의 목록입니다. |
UpdateFieldRequest
FirestoreAdmin.UpdateField
의 요청입니다.
필드 | |
---|---|
field |
필수 항목입니다. 업데이트할 필드입니다. |
update_mask |
필드를 기준으로 한 마스크입니다. 지정하면 이 field_mask가 지정한 구성만 필드에서 업데이트됩니다. |
주간 반복
지정된 요일에 실행되는 반복 일정을 나타냅니다.
시간대는 UTC입니다.
필드 | |
---|---|
day |
실행할 요일입니다. DAY_OF_WEEK_UNSPECIFIED는 허용되지 않습니다. |