Package google.firestore.admin.v1

string

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

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

string

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

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

string

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

Timestamp

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

Timestamp

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

State

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

string

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

자동으로 할당됩니다.

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

Timestamp

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

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

Timestamp

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

Duration

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

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

DailyRecurrence

매일 실행되는 일정의 경우

WeeklyRecurrence

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

string

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

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

BackupSchedule

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

string

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

Database

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

string

필수 항목입니다. 데이터베이스에 사용할 ID로, 데이터베이스 리소스 이름의 최종 구성요소가 됩니다.

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

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

string

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

Index

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

string

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

string

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

Timestamp

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

Timestamp

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

Timestamp

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

string

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

DatabaseType

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

ConcurrencyMode

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

Duration

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

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

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

Timestamp

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

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

PointInTimeRecoveryEnablement

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

AppEngineIntegrationMode

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

string

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

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

DeleteProtectionState

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

CmekConfig

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

string

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

string

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

string

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

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

내보내는 컬렉션 ID

string

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

string

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

Timestamp

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

string

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

string

내보낼 컬렉션 ID입니다. '지정되지 않음'은 모든 컬렉션을 의미합니다.

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가 네임스페이스 경로가 없는 버킷인 경우 시작 시간을 기준으로 프리픽스가 생성됩니다.

string

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

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

Timestamp

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

string

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

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 색인 구성이 없는 모든 필드에 적용됩니다.

IndexConfig

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

TtlConfig

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

Index

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

bool

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

string

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

bool

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

State

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

Timestamp

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

Timestamp

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

string

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

IndexConfigDelta

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

OperationState

작업 상태입니다.

Progress

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

Progress

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

TtlConfigDelta

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

ChangeType

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

Index

변경할 색인입니다.

ChangeType

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

string

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

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

string

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

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

string

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

string

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

string

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

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

가져오는 컬렉션 ID

string

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

string

가져오는 네임스페이스 ID입니다.

string

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

string

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

string

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

string

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

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

string

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

QueryScope

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

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

ApiScope

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

IndexField

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

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

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

State

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

string

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

Order

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

ArrayConfig

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

VectorConfig

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

int32

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

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

FlatIndex

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

Timestamp

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

Timestamp

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

string

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

OperationState

작업 상태입니다.

Progress

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

Progress

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

string

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

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

BackupSchedule

모든 백업 일정 목록

string

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

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

Backup

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

string

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

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

string

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

bool

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

Database

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

string

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

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

string

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

string

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

int32

반환할 결과 수입니다.

string

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

Field

요청된 필드입니다.

string

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

string

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

string

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

int32

반환할 결과 수입니다.

string

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

Index

요청된 색인입니다.

string

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

int64

예상 작업량입니다.

int64

완료된 작업의 양입니다.

Timestamp

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

Timestamp

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

OperationState

복원 작업 상태입니다.

string

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

string

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

Progress

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

string

필수 항목입니다. 데이터베이스를 복원할 프로젝트입니다. 형식은 projects/{project_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도 유효합니다.

string

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

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

BackupSchedule

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

FieldMask

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

Database

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

FieldMask

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

Field

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

FieldMask

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

DayOfWeek

실행할 요일입니다.

DAY_OF_WEEK_UNSPECIFIED는 허용되지 않습니다.