Package google.firestore.admin.v1

색인

FirestoreAdmin

Cloud Firestore Admin API입니다.

이 API는 Cloud Firestore를 위한 여러 관리 서비스를 제공합니다.

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

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

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

색인 생성은 비동기식으로 수행됩니다. 이러한 비동기 작업마다 Operation 리소스가 생성됩니다. 작업 상태 (발생한 오류 포함)는 작업 리소스를 통해 쿼리할 수 있습니다.

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

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

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

CreateBackupSchedule

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

데이터베이스에 백업 일정을 만듭니다. 한 데이터베이스에서는 최대 2개의 백업 일정을 구성할 수 있습니다. 일일 백업 일정(최대 7일 보관)과 주간 백업 일정(최대 14주 보관)을 구성할 수 있습니다.

승인 범위

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

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

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

CreateDatabase

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

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

DeleteBackupSchedule

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

백업 일정을 삭제합니다.

승인 범위

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

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

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

DeleteDatabase

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

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

ExportDocuments

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

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

GetDatabase

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

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

ImportDocuments

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

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

ListDatabases

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

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

RestoreDatabase

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

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

UpdateBackupSchedule

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

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

승인 범위

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

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

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

UpdateDatabase

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 지금은 백업을 사용할 수 없습니다.

BackupSchedule

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

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

입력란
name

string

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

자동으로 할당됩니다.

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

create_time

Timestamp

출력 전용. 이 백업 일정이 생성되어 유효한 타임스탬프입니다.

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

update_time

Timestamp

출력 전용. 이 백업 일정이 가장 최근에 업데이트된 타임스탬프입니다. 백업 일정을 처음 만들 때는 create_time과 동일합니다.

retention

Duration

생성 시간과 비교한 미래의 상대적 시점(예: 백업 7일 동안)을 삭제해야 합니다.

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

DailyRecurrence

매일 실행되는 일정에 사용됩니다.

weekly_recurrence

WeeklyRecurrence

특정 요일에 매주 실행되는 일정

CreateBackupScheduleRequest

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

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

DailyRecurrence

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

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

시간대는 UTC입니다.

데이터베이스

Cloud Firestore 데이터베이스입니다.

입력란
name

string

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

uid

string

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

create_time

Timestamp

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

update_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

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

etag

string

이 체크섬은 서버에서 다른 필드의 값을 기반으로 계산되며, 업데이트 및 삭제 요청 시 전송되기 전에 클라이언트가 최신 값을 유지하도록 할 수 있습니다.

AppEngineIntegrationMode

App Engine 통합 모드의 유형입니다.

열거형
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED 사용되지 않음.
ENABLED App Engine 애플리케이션이 이 데이터베이스와 동일한 리전에 있으면 App Engine 구성이 이 데이터베이스에 영향을 줍니다. 여기에는 애플리케이션 및 데이터베이스 사용 중지와 데이터베이스 쓰기 사용 중지가 포함됩니다.
DISABLED

App Engine은 이 데이터베이스의 요청 처리 기능에 영향을 미치지 않습니다.

Firestore API로 만든 데이터베이스의 기본 설정입니다.

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일 이내의 선택한 데이터 버전에서 지원됩니다.

  • 지난 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}입니다.

DeleteBackupScheduleRequest

[FirestoreAdmin.DeleteBackupSchedules][] 요청입니다.

입력란
name

string

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

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} 포맷

DeleteDatabaseMetadata

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

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

DeleteDatabaseRequest

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

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

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments의 요청입니다.

입력란
name

string

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

collection_ids[]

string

내보낼 컬렉션 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)이거나 특수 필드 경로일 수 있습니다. 유일하게 유효한 특수 필드는 모든 필드를 나타내는 *입니다.

필드 경로는 (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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*Field에 정의된 색인이 자체 Field 색인 구성이 없는 모든 필드에 적용됩니다.

index_config

IndexConfig

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

ttl_config

TtlConfig

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

IndexConfig

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

입력란
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가 됩니다.

TtlConfig

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

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

입력란
state

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

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 구성의 델타를 설명합니다.

IndexConfigDelta

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

입력란
change_type

ChangeType

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

index

Index

변경 중인 색인입니다.

ChangeType

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

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

TtlConfigDelta

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에서만 사용할 수 있습니다. 이는 기본값입니다.
DATASTORE_MODE_API 이 색인은 Datastore 모드의 Firestore 쿼리 API에서만 사용할 수 있습니다.

IndexField

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

입력란
field_path

string

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

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

Order

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

array_config

ArrayConfig

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

ArrayConfig

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

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

주문

지원되는 순서입니다.

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

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} 양식의 상위 요소 이름

ListDatabasesResponse

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

입력란
databases[]

Database

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

unreachable[]

string

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

예시 항목은 다음과 같습니다. projects/some_project/locations/some_location, 데이터베이스가 있는 Cloud 리전을 현재 사용할 수 없는 경우에 발생할 수 있습니다. 이 경우 데이터베이스에 대한 모든 세부정보를 가져올 수 없습니다. 리소스에 대한 'Get' 요청 또는 특정 위치에 대한 'List' 요청을 전송하여 자세한 오류 메시지를 받거나 리소스를 가져올 수 있습니다.

ListFieldsRequest

FirestoreAdmin.ListFields의 요청입니다.

입력란
parent

string

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

filter

string

목록 결과에 적용할 필터입니다. 현재 FirestoreAdmin.ListFields는 명시적으로 재정의된 필드 나열만 지원합니다. 이 쿼리를 실행하려면 indexConfig.usesAncestorConfig:false가 포함된 필터로 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가 지정한 구성만 필드에서 업데이트됩니다.

WeeklyRecurrence

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

시간대는 UTC입니다.

입력란
day

DayOfWeek

실행할 요일입니다.

DAY_OF_WEEK_UNSPECIFIED는 허용되지 않습니다.