Package google.firestore.admin.v1

색인

Firestore 관리자

Cloud Firestore Admin API

이 API는 Cloud Firestore에 몇 가지 관리 서비스를 제공합니다.

프로젝트, 데이터베이스, 네임스페이스, 컬렉션, 컬렉션 그룹, 문서는 Google Cloud Firestore API에 정의된 대로 사용됩니다.

작업: 작업은 백그라운드에서 실행 중인 작업을 나타냅니다.

색인 서비스는 Cloud Firestore 색인을 관리합니다.

색인 생성은 비동기식으로 실행됩니다. 작업 리소스는 이러한 각 비동기 작업에 대해 생성됩니다. 발생한 오류를 포함하여 작업의 상태는 Operation 리소스를 통해 쿼리할 수 있습니다.

작업 컬렉션은 진행 중인 작업을 포함하여 지정된 프로젝트에 대해 수행된 작업 기록을 제공합니다. 작업은 직접 생성되지 않고 다른 컬렉션 또는 리소스에 대한 호출을 통해 생성됩니다.

완료된 작업은 더 이상 작업 컬렉션의 일부로 나열되지 않도록 삭제될 수 있습니다. 작업은 30일 후 가비지로 수집됩니다. 기본적으로 ListOperations는 진행 중인 작업과 실패한 작업만 반환합니다. 완료된 작업을 나열하려면 done: true 필터를 사용하여 ListOperations 요청을 실행합니다.

작업은 FirestoreAdmin 서비스에서 생성되지만 google.longrunning.Operations 서비스를 통해 액세스됩니다.

백업 일정 만들기

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

데이터베이스에 백업 일정을 만듭니다. 데이터베이스 하나에 최대 2개의 백업 일정(일일 백업 일정 및 주간 백업 일정 1개)을 구성할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 만들기

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

데이터베이스를 만듭니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

복합 색인을 만듭니다. 그러면 생성 상태를 추적하는 데 사용할 수 있는 google.longrunning.Operation가 반환됩니다. 작업의 메타데이터는 IndexOperationMetadata 유형입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

DeleteBackup

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

백업을 삭제합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

백업 일정 삭제

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

백업 일정을 삭제합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 삭제

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

데이터베이스를 삭제합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

복합 색인을 삭제합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

문서 내보내기

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Google Cloud Firestore에서 문서의 전체 또는 하위 집합 사본을 다른 스토리지 시스템(예: Google Cloud Storage)으로 내보냅니다. 문서의 최근 업데이트가 내보내기에 반영되지 않을 수 있습니다. 내보내기는 백그라운드에서 실행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. 내보내기 출력은 연결된 작업이 완료된 후에만 사용할 수 있습니다. 내보내기 작업이 완료 전에 취소되면 Google Cloud Storage에 일부 데이터가 남을 수 있습니다.

내보내기 동작 및 출력 형식에 대한 자세한 내용은 https://cloud.google.com/firestore/docs/manage-data/export-import를 참조하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

GetBackup

rpc GetBackup(GetBackupRequest) returns (Backup)

백업 정보를 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

GetBackupSchedule 가져오기

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

백업 일정 정보를 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 가져오기

rpc GetDatabase(GetDatabaseRequest) returns (Database)

데이터베이스에 대한 정보를 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

GetField

rpc GetField(GetFieldRequest) returns (Field)

필드의 메타데이터 및 구성을 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

복합 색인을 가져옵니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

문서 가져오기

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Google Cloud Firestore로 문서를 가져옵니다. 이름이 동일한 기존 문서를 덮어씁니다. 가져오기는 백그라운드에서 수행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. ImportDocuments 작업이 취소되면 데이터의 하위 집합을 이미 Cloud Firestore로 가져왔을 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

ListBackupSchedules

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

백업 일정을 나열합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

ListBackups

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

모든 백업을 나열합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 나열

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

프로젝트의 모든 데이터베이스를 나열합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

이 데이터베이스의 필드 구성과 메타데이터를 나열합니다.

현재 FirestoreAdmin.ListFields는 명시적으로 재정의된 필드 나열만 지원합니다. 이 쿼리를 실행하려면 필터를 indexConfig.usesAncestorConfig:false 또는 ttlConfig:*로 설정하여 FirestoreAdmin.ListFields를 호출합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

복합 색인을 나열합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 복원

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

기존 백업에서 복원하여 새 데이터베이스를 만듭니다.

새 데이터베이스는 기존 백업과 동일한 클라우드 리전 또는 멀티 리전 위치에 있어야 합니다. 새로운 빈 데이터베이스를 만드는 대신 데이터베이스 유형, 색인 구성, 기존 백업의 문서로 새 데이터베이스가 생성된다는 점을 제외하면 [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] 와 유사하게 동작합니다.

long-running operation는 복원 진행 상황을 추적하는 데 사용할 수 있으며 작업의 metadata 필드 유형은 RestoreDatabaseMetadata입니다. 복원이 성공하면 response 유형은 Database입니다. LRO가 완료될 때까지 새 데이터베이스를 읽거나 쓸 수 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

백업 일정 업데이트

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

백업 일정을 업데이트합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

데이터베이스 업데이트

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

데이터베이스를 업데이트합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

필드 구성을 업데이트합니다. 현재 필드 업데이트는 단일 필드 색인 구성에만 적용됩니다. 그러나 FirestoreAdmin.UpdateField를 호출할 때 호출자가 인식하지 못하는 구성이 변경되지 않도록 필드 마스크를 제공해야 합니다. 필드 마스크는 { paths: "index_config" }로 지정해야 합니다.

이 호출은 필드 업데이트 상태를 추적하는 데 사용할 수 있는 google.longrunning.Operation을 반환합니다. 작업의 메타데이터는 FieldOperationMetadata 유형입니다.

데이터베이스의 기본 필드 설정을 구성하려면 리소스 이름이 projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*인 특수 Field를 사용합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

백업

Cloud Firestore 데이터베이스의 백업입니다.

백업에는 특정 시점에 지정된 데이터베이스의 모든 문서와 색인 구성이 포함됩니다.

필드
name

string

출력 전용입니다. 백업의 고유한 리소스 이름입니다.

형식은 projects/{project}/locations/{location}/backups/{backup}입니다.

database

string

출력 전용입니다. 백업의 출처인 Firestore 데이터베이스의 이름입니다.

형식은 projects/{project}/databases/{database}입니다.

database_uid

string

출력 전용입니다. 백업의 출처인 Firestore 데이터베이스의 시스템 생성 UUID4입니다.

snapshot_time

Timestamp

출력 전용입니다. 현재 백업에는 외부에서 일관된 데이터베이스 사본이 포함되어 있습니다.

expire_time

Timestamp

출력 전용입니다. 이 백업이 만료되는 타임스탬프입니다.

state

State

출력 전용입니다. 백업의 현재 상태입니다.

백업의 현재 상태를 나타냅니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
CREATING 대기 중인 백업을 아직 만드는 중입니다. 이 상태에서는 백업 작업이 거부됩니다.
READY 백업이 완료되어 사용할 준비가 되었습니다.
NOT_AVAILABLE 지금은 백업을 사용할 수 없습니다.

백업 일정

Cloud Firestore 데이터베이스의 백업 일정입니다.

이 리소스는 백업 중인 데이터베이스가 소유하며 데이터베이스와 함께 삭제됩니다. 하지만 실제 백업은 그렇지 않습니다.

필드
name

string

출력 전용입니다. 지정된 프로젝트의 모든 위치 및 데이터베이스에서 고유한 백업 일정 식별자입니다.

자동으로 할당됩니다.

형식은 projects/{project}/databases/{database}/backupSchedules/{backup_schedule}입니다.

create_time

Timestamp

출력 전용입니다. 이 백업 일정이 생성된 타임스탬프입니다.

이 시간 전에는 이 일정에 대한 백업이 생성되지 않습니다.

update_time

Timestamp

출력 전용입니다. 이 백업 일정이 가장 최근에 업데이트된 타임스탬프입니다. 백업 일정이 처음 생성되면 create_time과 동일합니다.

retention

Duration

생성 시간과 비교하여 미래의 상대적 시점에 백업을 삭제해야 합니다. 예: 7일 동안 백업을 보관할 수 있습니다

지원되는 최대 보관 기간은 14주입니다.

통합 필드 recurrence. 백업이 실행되는 시점을 나타내는 oneof 필드입니다. recurrence은 다음 중 하나여야 합니다.
daily_recurrence

DailyRecurrence

매일 실행되는 일정의 경우

weekly_recurrence

WeeklyRecurrence

매주 특정 요일에 실행되는 일정의 경우

백업 예약 요청 만들기

FirestoreAdmin.CreateBackupSchedule의 요청입니다.

필드
parent

string

필수 항목입니다. 상위 데이터베이스입니다.

projects/{project}/databases/{database} 형식

backup_schedule

BackupSchedule

필수 항목입니다. 생성할 백업 일정입니다.

CreateDatabaseMetadata

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

데이터베이스 만들기 작업과 관련된 메타데이터입니다.

CreateDatabaseRequest

FirestoreAdmin.CreateDatabase의 요청입니다.

필드
parent

string

필수 항목입니다. projects/{project_id} 양식의 상위 이름

database

Database

필수 항목입니다. 생성할 데이터베이스입니다.

database_id

string

필수 항목입니다. 데이터베이스에 사용할 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

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} 양식의 상위 이름

index

Index

필수 항목입니다. 만들 복합 색인입니다.

일일 반복

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

매일 실행되는 반복되는 일정을 나타냅니다.

시간대는 UTC입니다.

데이터베이스

Cloud Firestore 데이터베이스

필드
name

string

데이터베이스의 리소스 이름입니다. 형식: projects/{project}/databases/{database}

uid

string

출력 전용입니다. 이 데이터베이스의 시스템 생성 UUID4입니다.

create_time

Timestamp

출력 전용입니다. 이 데이터베이스가 생성된 타임스탬프입니다. 2016년 이전에 생성된 데이터베이스는 create_time을 채우지 않습니다.

update_time

Timestamp

출력 전용입니다. 이 데이터베이스가 가장 최근에 업데이트된 타임스탬프입니다. 여기에는 데이터베이스 리소스 업데이트만 포함되며 데이터베이스에 포함된 데이터는 포함되지 않습니다.

delete_time

Timestamp

출력 전용입니다. 데이터베이스가 삭제된 타임스탬프입니다. 데이터베이스가 삭제된 경우에만 설정됩니다.

location_id

string

데이터베이스의 위치입니다. 사용 가능한 위치는 https://cloud.google.com/firestore/docs/locations에서 확인할 수 있습니다.

type

DatabaseType

데이터베이스의 유형입니다. 선택 방법에 대한 자세한 내용은 https://cloud.google.com/datastore/docs/firestore-or-datastore를 참조하세요.

concurrency_mode

ConcurrencyMode

이 데이터베이스에 사용할 동시 실행 제어 모드입니다.

version_retention_period

Duration

출력 전용입니다. 이전 버전의 데이터가 데이터베이스에 보관되는 기간입니다.

모든 read 또는 query는 이 기간 내에 read_time를 지정할 수 있으며 그 시점의 데이터베이스 상태를 읽습니다.

PITR 기능이 사용 설정된 경우 보관 기간은 7일입니다. 그 외의 경우에는 보관 기간은 1시간입니다.

earliest_version_time

Timestamp

출력 전용입니다. 데이터베이스에서 이전 버전의 데이터를 읽을 수 있는 가장 이른 타임스탬프입니다. 위의 [version_retention_period] 를 참고하세요. 이 필드는 now - version_retention_period로 채워집니다.

이 값은 지속적으로 업데이트되며 쿼리되는 순간 비활성 상태가 됩니다. 이 값을 사용하여 데이터를 복구하는 경우, 값이 쿼리된 순간부터 복구를 시작하는 순간까지의 기간을 고려해야 합니다.

point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

이 데이터베이스에서 PITR 기능을 사용 설정할지 여부입니다.

app_engine_integration_mode

AppEngineIntegrationMode

이 데이터베이스에 사용할 App Engine 통합 모드입니다.

key_prefix

string

출력 전용입니다. 이 데이터베이스의 key_prefix입니다. 이 key_prefix는 프로젝트 ID('~')와 함께 사용되어 Google App Engine 1세대 런타임의 Cloud Datastore API에서 반환되는 애플리케이션 ID를 구성합니다.

이 값은 비어 있을 수 있습니다. 이 경우 URL로 인코딩된 키에 사용할 appid는 project_id입니다 (예: v~foo가 아닌 foo).

delete_protection_state

DeleteProtectionState

데이터베이스에 대한 삭제 보호 상태입니다.

cmek_config

CmekConfig

선택사항입니다. 현재 상태는 이 데이터베이스에 CMEK가 사용 설정되어 있음을 나타냅니다.

previous_id

string

출력 전용입니다. 데이터베이스 리소스의 이전 데이터베이스 ID입니다. 이 필드는 삭제된 데이터베이스에만 채워집니다.

etag

string

이 체크섬은 다른 필드의 값을 기준으로 서버에서 계산되며, 처리 전 클라이언트에 최신 값이 적용되도록 업데이트 및 삭제 요청이 있을 때 전송될 수 있습니다.

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

string

필수 항목입니다. 이 데이터베이스와 동일한 위치에 있는 키만 암호화에 사용할 수 있습니다.

Firestore의 nam5 멀티 리전의 경우 이는 Cloud KMS 멀티 리전 us에 해당합니다. Firestore의 eur3 멀티 리전의 경우 Cloud KMS 멀티 리전 유럽에 해당합니다. https://cloud.google.com/kms/docs/locations를 참조하세요.

예상되는 형식은 projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}입니다.

active_key_version[]

string

출력 전용입니다. 현재 사용 중인 KMS 키 버전. 키 순환 중에 사용 중인 키 버전이 여러 개 있을 수 있습니다.

예상되는 형식은 projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}입니다.

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 네이티브 모드
DATASTORE_MODE Datastore 모드의 Firestore

DeleteProtectionState

데이터베이스의 삭제 보호 상태입니다.

열거형
DELETE_PROTECTION_STATE_UNSPECIFIED 기본값입니다. 삭제 보호 유형이 지정되지 않았습니다.
DELETE_PROTECTION_DISABLED 삭제 보호가 사용 중지되었습니다.
DELETE_PROTECTION_ENABLED 삭제 보호가 사용 설정되었습니다.

특정 시점 복구 사용 설정

PITR(point-in-time recovery) 기능 사용 설정

열거형
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED 사용되지 않음.
POINT_IN_TIME_RECOVERY_ENABLED

지난 7일 이내의 일부 데이터 버전에서 읽기가 지원됩니다.

  • 지난 1시간 이내의 모든 타임스탬프에 대해 읽습니다.
  • 1시간 초과 및 7일 이내의 1분 스냅샷에 대해 읽습니다.

version_retention_periodearliest_version_time를 사용하여 지원되는 버전을 확인할 수 있습니다.

POINT_IN_TIME_RECOVERY_DISABLED 지난 1시간 이내의 모든 데이터 버전에서 읽기가 지원됩니다.

DeleteBackupRequest

FirestoreAdmin.DeleteBackup의 요청입니다.

필드
name

string

필수 항목입니다. 삭제할 백업의 이름입니다.

형식은 projects/{project}/locations/{location}/backups/{backup}입니다.

백업 예약 요청 삭제

[FirestoreAdmin.DeleteBackupSchedules][]에 대한 요청입니다.

필드
name

string

필수 항목입니다. 백업 일정의 이름입니다.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} 형식

DeleteDatabaseMetadata

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

데이터베이스 삭제 작업과 관련된 메타데이터입니다.

데이터베이스 요청 삭제

FirestoreAdmin.DeleteDatabase의 요청입니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id} 양식의 이름

etag

string

데이터베이스의 현재 etag입니다. etag가 제공되었는데 데이터베이스의 현재 etag와 일치하지 않으면 삭제가 차단되고 FAILED_PRECONDITION 오류가 반환됩니다.

DeleteIndexRequest

FirestoreAdmin.DeleteIndex의 요청입니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} 양식의 이름

ExportDocumentsMetadata

FirestoreAdmin.ExportDocuments의 결과 google.longrunning.Operation개에 대한 메타데이터입니다.

필드
start_time

Timestamp

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

end_time

Timestamp

이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정 해제됩니다.

operation_state

OperationState

내보내기 작업의 상태입니다.

progress_documents

Progress

이 작업의 진행률(문서)입니다.

progress_bytes

Progress

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

collection_ids[]

string

내보낼 컬렉션 ID

output_uri_prefix

string

문서를 내보낼 위치입니다.

namespace_ids[]

string

내보낼 네임스페이스 ID입니다.

snapshot_time

Timestamp

내보내는 데이터베이스의 버전에 해당하는 타임스탬프입니다. 지정하지 않으면 내보내는 문서의 일관성이 보장되지 않습니다.

문서 내보내기 요청

FirestoreAdmin.ExportDocuments의 요청입니다.

필드
name

string

필수 항목입니다. 내보낼 데이터베이스입니다. projects/{project_id}/databases/{database_id} 형식이어야 합니다.

collection_ids[]

string

내보낼 컬렉션 ID입니다. '지정되지 않음'은 모든 컬렉션을 의미합니다. 이 목록의 각 컬렉션 ID는 고유해야 합니다.

output_uri_prefix

string

출력 URI입니다. 현재는 gs://BUCKET_NAME[/NAMESPACE_PATH] 형식의 Google Cloud Storage URI만 지원합니다. 여기서 BUCKET_NAME은 Google Cloud Storage 버킷의 이름이고 NAMESPACE_PATH은 선택적 Google Cloud Storage 네임스페이스 경로입니다. 이름을 선택할 때는 Google Cloud Storage 이름 지정 가이드라인(https://cloud.google.com/storage/docs/naming)을 고려하세요. URI가 네임스페이스 경로가 없는 버킷인 경우 시작 시간을 기준으로 프리픽스가 생성됩니다.

namespace_ids[]

string

빈 목록은 모든 네임스페이스를 나타냅니다. 네임스페이스를 사용하지 않는 데이터베이스에 선호되는 용도입니다.

빈 문자열 요소는 기본 네임스페이스를 나타냅니다. 데이터베이스의 기본이 아닌 네임스페이스에 데이터가 있지만 이를 포함하지 않으려는 경우에 사용해야 합니다. 이 목록의 각 네임스페이스는 고유해야 합니다.

snapshot_time

Timestamp

내보낼 데이터베이스의 버전에 해당하는 타임스탬프입니다. 타임스탬프는 과거의 날짜여야 하며, 분 단위로 반올림되고 earliestVersionTime 이전이어야 합니다. 지정하면 내보낸 문서는 제공된 시간에 데이터베이스의 일관된 보기를 나타냅니다. 그렇지 않으면 내보낸 문서의 일관성이 보장되지 않습니다.

ExportDocumentsResponse

google.longrunning.Operation 응답 필드에 반환됩니다.

필드
output_uri_prefix

string

출력 파일의 위치입니다. 작업이 성공적으로 완료된 후 Cloud Firestore (이 프로젝트 또는 다른 프로젝트)로 가져오기를 시작하는 데 사용할 수 있습니다.

필드

데이터베이스의 단일 필드를 나타냅니다.

필드는 ID가 동일한 데이터베이스의 모든 컬렉션을 나타내는 '컬렉션 그룹'으로 그룹화됩니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} 형식의 필드 이름

필드 경로는 다음과 같은 간단한 필드 이름일 수 있습니다. address 또는 map_value 내의 필드 경로입니다. 예: address.city 또는 특수 필드 경로입니다. 유일하게 유효한 특수 필드는 모든 필드를 나타내는 *입니다.

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

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

특별한 Field에는 모든 필드의 기본 색인 생성 설정이 포함되어 있습니다. 이 필드의 리소스 이름: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*Field에 정의된 색인은 자체 Field 색인 구성이 없는 모든 필드에 적용됩니다.

index_config

IndexConfig

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

ttl_config

TtlConfig

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

색인 구성

이 필드의 색인 구성입니다.

필드
indexes[]

Index

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

uses_ancestor_config

bool

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

ancestor_field

string

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

reverting

bool

출력 전용 true인 경우 Field의 색인 구성을 되돌리는 중입니다. 완료되면 색인 구성이 ancestor_field로 지정된 필드와 동일한 상태로 전환되며 이때 uses_ancestor_configtrue이 되고 revertingfalse이 됩니다.

TTL 구성

Field가 설정된 문서의 TTL (수명) 구성입니다.

TTL이 사용 설정된 필드에 타임스탬프 값을 저장하면 문서의 절대 만료 시간으로 처리됩니다. 과거의 타임스탬프 값은 문서가 즉시 만료될 수 있음을 나타냅니다. 다른 데이터 유형을 사용하거나 필드를 비워두면 개별 문서의 만료가 사용 중지됩니다.

필드
state

State

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

모든 문서에 TTL 구성이 적용되는 상태입니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았거나 알 수 없습니다.
CREATING TTL을 적용하는 중입니다. 변경사항을 추적하는 활성 장기 실행 작업이 있습니다. 새로 작성된 문서에는 요청에 따라 TTL이 적용됩니다. 기존 문서에서 요청된 TTL을 아직 처리 중입니다. 모든 기존 문서의 TTL이 처리되면 상태가 '활성'으로 이동합니다.
ACTIVE TTL은 모든 문서에 대해 활성화됩니다.
NEEDS_REPAIR 모든 기존 문서에 TTL 구성을 사용 설정할 수 없습니다. 새로 작성된 문서에는 TTL이 계속 적용됩니다. 이 Field에 TTL을 사용 설정하려고 마지막으로 시도했을 때 LRO가 반환되었으며 세부정보가 포함되어 있을 수 있습니다.

FieldOperationMetadata

FirestoreAdmin.UpdateField의 결과 google.longrunning.Operation개에 대한 메타데이터입니다.

필드
start_time

Timestamp

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

end_time

Timestamp

이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정 해제됩니다.

field

string

이 작업이 실행되는 필드 리소스입니다. 예: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

이 작업의 인텐트를 설명하는 IndexConfigDelta 목록

state

OperationState

작업 상태입니다.

progress_documents

Progress

이 작업의 진행률(문서)입니다.

progress_bytes

Progress

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

ttl_config_delta

TtlConfigDelta

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

색인 구성 델타

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

필드
change_type

ChangeType

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

index

Index

변경할 색인입니다.

ChangeType

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

열거형
CHANGE_TYPE_UNSPECIFIED 변경 유형이 지정되지 않았거나 알 수 없습니다.
ADD 단일 필드 색인을 추가하는 중입니다.
REMOVE 단일 필드 색인을 삭제하는 중입니다.

TTL 구성 델타

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

필드
change_type

ChangeType

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

ChangeType

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

열거형
CHANGE_TYPE_UNSPECIFIED 변경 유형이 지정되지 않았거나 알 수 없습니다.
ADD TTL 구성을 추가하는 중입니다.
REMOVE TTL 구성을 삭제하는 중입니다.

GetBackupRequest

FirestoreAdmin.GetBackup의 요청입니다.

필드
name

string

필수 항목입니다. 가져올 백업의 이름입니다.

형식은 projects/{project}/locations/{location}/backups/{backup}입니다.

GetBackupScheduleRequest

FirestoreAdmin.GetBackupSchedule의 요청입니다.

필드
name

string

필수 항목입니다. 백업 일정의 이름입니다.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} 형식

GetDatabaseRequest

FirestoreAdmin.GetDatabase의 요청입니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id} 양식의 이름

GetFieldRequest

FirestoreAdmin.GetField의 요청입니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id} 양식의 이름

GetIndexRequest

FirestoreAdmin.GetIndex의 요청입니다.

필드
name

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} 양식의 이름

ImportDocumentsMetadata

FirestoreAdmin.ImportDocuments의 결과 google.longrunning.Operation개에 대한 메타데이터입니다.

필드
start_time

Timestamp

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

end_time

Timestamp

이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정 해제됩니다.

operation_state

OperationState

가져오기 작업의 상태입니다.

progress_documents

Progress

이 작업의 진행률(문서)입니다.

progress_bytes

Progress

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

collection_ids[]

string

가져오는 컬렉션 ID

input_uri_prefix

string

가져오는 문서의 위치입니다.

namespace_ids[]

string

가져오는 네임스페이스 ID

ImportDocumentsRequest(문서 가져오기 요청)

FirestoreAdmin.ImportDocuments의 요청입니다.

필드
name

string

필수 항목입니다. 가져올 데이터베이스입니다. projects/{project_id}/databases/{database_id} 형식이어야 합니다.

collection_ids[]

string

가져올 컬렉션 ID입니다. 미지정은 가져오기에 포함된 모든 컬렉션을 의미합니다.

input_uri_prefix

string

내보낸 파일의 위치입니다. 성공적으로 완료된 내보내기에서 ExportDocumentsResponse의 output_uri_prefix와 일치해야 합니다. google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix를 참고하세요.

namespace_ids[]

string

빈 목록은 모든 네임스페이스를 나타냅니다. 네임스페이스를 사용하지 않는 데이터베이스에 선호되는 용도입니다.

빈 문자열 요소는 기본 네임스페이스를 나타냅니다. 데이터베이스의 기본이 아닌 네임스페이스에 데이터가 있지만 이를 포함하지 않으려는 경우에 사용해야 합니다. 이 목록의 각 네임스페이스는 고유해야 합니다.

색인

Cloud Firestore 색인은 데이터베이스의 문서에 대해 간단한 쿼리와 복잡한 쿼리를 지원합니다.

필드
name

string

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

query_scope

QueryScope

컬렉션 쿼리 범위가 지정된 색인을 사용하면 특정 문서의 하위 요소이고, 쿼리 시 지정되고, 컬렉션 ID가 동일한 컬렉션에 대한 쿼리를 허용합니다.

컬렉션 그룹 쿼리 범위가 지정된 색인을 사용하면 쿼리 시 지정되고 이 색인과 컬렉션 ID가 동일한 특정 문서의 모든 컬렉션에 대한 쿼리가 허용됩니다.

api_scope

ApiScope

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

fields[]

IndexField

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

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

단일 필드 색인의 경우 필드 경로가 연결된 필드의 필드 경로와 동일한 정확히 하나의 항목입니다.

state

State

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

ApiScope

API 범위는 쿼리에 지원되는 API (Firestore Native 또는 Datastore 모드의 Firestore)를 정의합니다.

열거형
ANY_API 색인은 Firestore Native Query API에서만 사용할 수 있습니다. 전역 window는 기본 설정이며,
DATASTORE_MODE_API 이 색인은 Datastore 모드의 Firestore Query API에서만 사용할 수 있습니다.

색인 필드

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

필드
field_path

string

name일 수 있습니다. 단일 필드 색인의 경우 필드 이름과 일치해야 하거나 생략할 수 있습니다.

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

Order

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

array_config

ArrayConfig

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

vector_config

VectorConfig

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

ArrayConfig

지원되는 배열 값 구성입니다.

열거형
ARRAY_CONFIG_UNSPECIFIED 색인은 추가 배열 쿼리를 지원하지 않습니다.
CONTAINS 색인은 배열 포함 쿼리를 지원합니다.

주문

지원되는 순서 지정입니다.

열거형
ORDER_UNSPECIFIED 순서가 지정되지 않았습니다. 유효한 옵션이 아닙니다.
ASCENDING 필드는 필드 값의 오름차순으로 정렬됩니다.
DESCENDING 필드는 내림차순 필드 값을 기준으로 정렬됩니다.

벡터 구성

벡터 검색 작업을 지원하기 위한 색인 구성

필드
dimension

int32

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

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

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

FlatIndex

벡터 색인이 플랫 색인임을 나타냅니다.

FlatIndex

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

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

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

Timestamp

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

end_time

Timestamp

이 작업이 완료된 시간입니다. 작업이 아직 진행 중인 경우 설정 해제됩니다.

index

string

이 작업이 실행되는 색인 리소스입니다. 예: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

state

OperationState

작업 상태입니다.

progress_documents

Progress

이 작업의 진행률(문서)입니다.

progress_bytes

Progress

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

ListBackupSchedulesRequest

FirestoreAdmin.ListBackupSchedules의 요청입니다.

필드
parent

string

필수 항목입니다. 상위 데이터베이스입니다.

형식은 projects/{project}/databases/{database}입니다.

ListBackupSchedulesResponse

FirestoreAdmin.ListBackupSchedules의 응답입니다.

필드
backup_schedules[]

BackupSchedule

모든 백업 일정 목록

ListBackupsRequest

FirestoreAdmin.ListBackups의 요청입니다.

필드
parent

string

필수 항목입니다. 백업을 나열할 위치입니다.

형식은 projects/{project}/locations/{location}입니다. {location} = '-'를 사용하여 지정된 프로젝트의 모든 위치의 백업을 나열합니다. 이렇게 하면 단일 위치 또는 모든 위치의 백업을 나열할 수 있습니다.

ListBackupsResponse

FirestoreAdmin.ListBackups의 응답입니다.

필드
backups[]

Backup

프로젝트의 모든 백업 목록입니다.

unreachable[]

string

기존 백업을 가져올 수 없는 위치의 목록입니다.

단일 위치에 연결할 수 없을 때 전체 요청을 실패하는 대신, 이 응답은 부분 결과 집합과 여기에서 도달할 수 없는 위치 목록을 반환합니다. 단일 위치에 대해 요청을 재시도하여 구체적인 오류를 얻을 수 있습니다.

ListDatabasesRequest

프로젝트의 모든 위치에 Firestore 데이터베이스를 나열하기 위한 요청입니다.

필드
parent

string

필수 항목입니다. projects/{project_id} 양식의 상위 이름

show_deleted

bool

true인 경우 삭제된 리소스도 반환합니다.

ListDatabasesResponse

프로젝트의 데이터베이스 목록입니다.

필드
databases[]

Database

프로젝트의 데이터베이스입니다.

unreachable[]

string

개별 데이터베이스에 대한 데이터를 나열할 수 없는 경우 여기에 기록됩니다.

항목의 예시는 다음과 같습니다. projects/some_project/locations/some_location 이 문제는 데이터베이스가 있는 Cloud 리전을 현재 사용할 수 없는 경우에 발생할 수 있습니다. 이 경우 데이터베이스에 관한 모든 세부정보를 가져올 수 없습니다. 'Get' 명령어를 전송하여 더 자세한 오류 메시지를 가져오거나 리소스를 가져올 수 있습니다. 리소스 또는 '목록' 요청을 요청할 수 있습니다.

ListFieldsRequest

FirestoreAdmin.ListFields의 요청입니다.

필드
parent

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} 양식의 상위 이름

filter

string

목록 결과에 적용할 필터입니다. 현재 FirestoreAdmin.ListFields는 명시적으로 재정의된 필드 나열만 지원합니다. 이 쿼리를 실행하려면 indexConfig.usesAncestorConfig:false 또는 ttlConfig:*가 포함된 필터로 FirestoreAdmin.ListFields를 호출합니다.

page_size

int32

반환할 결과 수입니다.

page_token

string

이전 FirestoreAdmin.ListFields 호출에서 반환된 페이지 토큰으로, 결과의 다음 페이지를 가져오는 데 사용할 수 있습니다.

ListFieldsResponse

FirestoreAdmin.ListFields의 응답입니다.

필드
fields[]

Field

요청된 필드입니다.

next_page_token

string

다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비워 두면 마지막 페이지가 됩니다.

ListIndexesRequest

FirestoreAdmin.ListIndexes의 요청입니다.

필드
parent

string

필수 항목입니다. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} 양식의 상위 이름

filter

string

목록 결과에 적용할 필터입니다.

page_size

int32

반환할 결과 수입니다.

page_token

string

이전 FirestoreAdmin.ListIndexes 호출에서 반환된 페이지 토큰으로, 결과의 다음 페이지를 가져오는 데 사용할 수 있습니다.

ListIndexesResponse

FirestoreAdmin.ListIndexes의 응답입니다.

필드
indexes[]

Index

요청된 색인입니다.

next_page_token

string

다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비워 두면 마지막 페이지가 됩니다.

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

int64

예상 작업량입니다.

completed_work

int64

완료된 작업의 양입니다.

RestoreDatabaseMetadata

[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] 요청의 long-running operation 메타데이터입니다.

필드
start_time

Timestamp

복원이 시작된 시간입니다.

end_time

Timestamp

복원이 완료된 시간으로, 진행 중인 복원에 대해 설정되지 않습니다.

operation_state

OperationState

복원 작업 상태입니다.

database

string

복원할 데이터베이스의 이름입니다.

backup

string

복원 대상인 백업의 이름입니다.

progress_percentage

Progress

복원이 진행된 기간을 남은 시간의 예상 백분율로 나타낸 값입니다.

RestoreDatabaseRequest

[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]에 대한 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 데이터베이스를 복원할 프로젝트입니다. 형식은 projects/{project_id}입니다.

database_id

string

필수 항목입니다. 데이터베이스에 사용할 ID로, 데이터베이스 리소스 이름의 최종 구성요소가 됩니다. 이 데이터베이스 ID는 기존 데이터베이스와 연결되어서는 안 됩니다.

이 값은 4~63자(영문 기준)여야 합니다. 유효한 문자는 /[a-z][0-9]-/ 이며 첫 번째 문자는 문자, 마지막 문자는 문자 또는 숫자여야 합니다. UUID와 같은 /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/가 아니어야 합니다.

'(기본값)' 데이터베이스 ID도 유효합니다.

통합 필드 source.

source는 다음 중 하나여야 합니다.

backup

string

복원할 백업입니다. 상위 요소와 동일한 프로젝트에 속해야 합니다.

형식은 projects/{project_id}/locations/{location}/backups/{backup}입니다.

UpdateBackupScheduleRequest

FirestoreAdmin.UpdateBackupSchedule의 요청입니다.

필드
backup_schedule

BackupSchedule

필수 항목입니다. 업데이트할 백업 일정입니다.

update_mask

FieldMask

업데이트할 필드 목록입니다.

UpdateDatabaseMetadata

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

데이터베이스 업데이트 작업과 관련된 메타데이터입니다.

UpdateDatabaseRequest

FirestoreAdmin.UpdateDatabase의 요청입니다.

필드
database

Database

필수 항목입니다. 업데이트할 데이터베이스입니다.

update_mask

FieldMask

업데이트할 필드 목록입니다.

UpdateFieldRequest

FirestoreAdmin.UpdateField의 요청입니다.

필드
field

Field

필수 항목입니다. 업데이트할 필드입니다.

update_mask

FieldMask

필드를 기준으로 한 마스크. 지정하면 이 field_mask가 지정한 구성만 필드에서 업데이트됩니다.

주간 반복

지정된 요일에 실행되는 반복 일정을 나타냅니다.

시간대는 UTC입니다.

필드
day

DayOfWeek

실행할 요일입니다.

DAY_OF_WEEK_UNSPECIFIED는 허용되지 않습니다.