Package google.firestore.admin.v1beta1

색인

Firestore관리자

Cloud Firestore 관리 API.

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

개념

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

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

서비스

색인

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

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

메타데이터

Cloud Firestore의 데이터에 대한 메타데이터 및 통계 정보를 제공합니다. 이 API의 일부로 제공되는 데이터는 오래되었을 수 있습니다.

작업

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

아직 완료되지 않은 작업은 취소될 수 있습니다. 취소 요청은 비동기식이며 취소 요청이 이루어진 후에도 일정 시간 동안 작업이 계속 실행될 수 있습니다.

완료된 작업은 삭제되어 더 이상 작업 컬렉션의 일부로 나열되지 않을 수 있습니다.

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

인덱스 생성

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

지정된 인덱스를 생성합니다. 새로 생성된 인덱스의 초기 상태는 CREATING 입니다. 반환된 google.longrunning.Operation 완료되면 상태는 READY 됩니다. 인덱스가 이미 존재하는 경우 호출은 ALREADY_EXISTS 상태를 반환합니다.

생성 중에 프로세스에 오류가 발생할 수 있으며, 이 경우 인덱스가 ERROR 상태로 전환됩니다. 오류를 일으킨 데이터를 수정하고 delete 로 인덱스를 제거한 다음 create 로 인덱스를 다시 생성하면 프로세스를 복구할 수 있습니다.

단일 필드가 있는 인덱스는 생성할 수 없습니다.

승인 범위

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

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

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

삭제인덱스

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에 일부 데이터가 남을 수 있습니다.

승인 범위

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

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

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

인덱스 가져오기

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

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

목록 인덱스

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

지정된 필터와 일치하는 인덱스를 나열합니다.

승인 범위

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

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

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

CreateIndex요청

FirestoreAdmin.CreateIndex 에 대한 요청입니다.

필드
parent

string

이 인덱스가 적용될 데이터베이스의 이름입니다. 예: projects/{project_id}/databases/{database_id}

index

Index

생성할 인덱스입니다. 이름 및 상태 필드는 출력 전용이며 무시됩니다. 특정 단일 필드 인덱스는 생성하거나 삭제할 수 없습니다.

삭제인덱스요청

FirestoreAdmin.DeleteIndex 에 대한 요청입니다.

필드
name

string

인덱스 이름입니다. 예: projects/{project_id}/databases/{database_id}/indexes/{index_id}

내보내기문서메타데이터

ImportDocuments 작업에 대한 메타데이터입니다.

필드
start_time

Timestamp

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

end_time

Timestamp

성공적으로 또는 그렇지 않게 작업이 종료된 시간입니다. 작업이 여전히 활성 상태인 경우 설정을 해제합니다.

operation_state

OperationState

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

progress_documents

Progress

처리된 문서 수의 추정치입니다.

progress_bytes

Progress

처리된 바이트 수의 추정치입니다.

collection_ids[]

string

내보내는 컬렉션 ID입니다.

output_uri_prefix

string

엔터티를 내보내는 위치입니다.

문서 내보내기요청

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가 버킷(네임스페이스 경로 없음)인 경우 시작 시간을 기준으로 접두사가 생성됩니다.

내보내기문서응답

google.longrunning.Operation 응답 필드에 반환되었습니다.

필드
output_uri_prefix

string

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

GetIndex요청

FirestoreAdmin.GetIndex 에 대한 요청입니다.

필드
name

string

인덱스의 이름입니다. 예: projects/{project_id}/databases/{database_id}/indexes/{index_id}

가져오기문서메타데이터

ImportDocuments 작업에 대한 메타데이터입니다.

필드
start_time

Timestamp

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

end_time

Timestamp

성공적으로 또는 그렇지 않게 작업이 종료된 시간입니다. 작업이 여전히 활성 상태인 경우 설정을 해제합니다.

operation_state

OperationState

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

progress_documents

Progress

처리된 문서 수의 추정치입니다.

progress_bytes

Progress

처리된 바이트 수의 추정치입니다.

collection_ids[]

string

가져오는 컬렉션 ID입니다.

input_uri_prefix

string

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

문서 가져오기요청

FirestoreAdmin.ImportDocuments 에 대한 요청입니다.

필드
name

string

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

collection_ids[]

string

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

input_uri_prefix

string

내보낸 파일의 위치입니다. 이는 성공적으로 완료된 내보내기의 ImportDocumentsResponse의 output_uri_prefix와 일치해야 합니다. google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix 를 참조하세요.

색인

인덱스 정의.

필드
name

string

인덱스의 리소스 이름입니다. 출력만 가능합니다.

collection_id

string

이 인덱스가 적용되는 컬렉션 ID입니다. 필수의.

fields[]

IndexField

색인을 생성할 필드입니다.

state

State

인덱스의 상태입니다. 출력만 가능합니다.

상태

인덱스의 상태입니다. 인덱스 생성 중에 인덱스는 CREATING 상태가 됩니다. 인덱스가 성공적으로 생성되면 READY 상태로 전환됩니다. 인덱스를 생성할 수 없으면 ERROR 상태로 전환됩니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
CREATING 인덱스를 생성하는 중입니다. 인덱스에 대해 활성 장기 실행 작업이 있습니다. 문서를 작성할 때 색인이 업데이트됩니다. 일부 인덱스 데이터가 존재할 수 있습니다.
READY 인덱스를 사용할 준비가 되었습니다. 문서를 작성할 때 색인이 업데이트됩니다. 인덱스는 적용되는 모든 저장된 문서에서 완전히 채워집니다.
ERROR 인덱스를 생성하는 중이지만 문제가 발생했습니다. 인덱스에 대한 활성 장기 실행 작업이 없으며 가장 최근에 완료된 장기 실행 작업이 실패했습니다. 문서를 작성할 때 색인은 업데이트되지 않습니다. 일부 인덱스 데이터가 존재할 수 있습니다.

인덱스필드

인덱스의 필드입니다.

필드
field_path

string

필드의 경로입니다. [google.firestore.v1beta1.Document.fields][fields]에 설명된 필드 경로 사양과 일치해야 합니다. 특수 필드 경로 __name__ 단독으로 사용되거나 경로 끝에 사용될 수 있습니다. __type__ 경로 끝에서만 사용할 수 있습니다.

mode

Mode

필드의 모드입니다.

방법

모드는 필드가 색인화되는 방식을 결정합니다.

열거형
MODE_UNSPECIFIED 모드가 지정되지 않았습니다.
ASCENDING 필드 값은 오름차순 순서를 지원하고 <, >, <=, >= 및 =별로 쿼리할 수 있도록 인덱싱됩니다.
DESCENDING 필드 값은 내림차순 순서 지정을 지원하고 <, >, <=, >= 및 =별로 쿼리할 수 있도록 인덱싱됩니다.
ARRAY_CONTAINS 필드의 배열 값은 ARRAY_CONTAINS 쿼리를 사용하여 멤버십을 지원하도록 색인화됩니다.

IndexOperationMetadata

인덱스 작업을 위한 메타데이터입니다. 이 메타데이터는 google.longrunning.Operation 의 메타데이터 필드를 채웁니다.

필드
start_time

Timestamp

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

end_time

Timestamp

성공적으로 또는 그렇지 않게 작업이 종료된 시간입니다. 작업이 여전히 활성 상태인 경우 설정을 해제합니다.

index

string

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

operation_type

OperationType

인덱스 작업의 유형입니다.

cancelled

bool

google.longrunning.Operation 이 취소된 경우 True입니다. 취소가 진행 중인 경우 cancelled는 true가 되지만 google.longrunning.Operation.done false가 됩니다.

document_progress

Progress

문서 수로 측정된 기존 작업의 진행 상황입니다.

작업 유형

인덱스 작업의 유형입니다.

열거형
OPERATION_TYPE_UNSPECIFIED 지정되지 않음. 서버에서 설정하지 마십시오.
CREATING_INDEX 작업이 인덱스를 생성하는 중입니다. CreateIndex 호출에 의해 시작됩니다.

목록인덱스요청

FirestoreAdmin.ListIndexes 에 대한 요청입니다.

필드
parent

string

데이터베이스 이름입니다. 예: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

표준 목록 페이지 크기입니다.

page_token

string

표준 목록 페이지 토큰입니다.

목록인덱스응답

FirestoreAdmin.ListIndexes 에 대한 응답입니다.

필드
indexes[]

Index

인덱스.

next_page_token

string

표준 목록 다음 페이지 토큰입니다.

위치메타데이터

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

google.cloud.location.Location.metadata 에 대한 메타데이터 메시지입니다.

작업 상태

진행 중인 작업에 대해 가능한 다양한 상태입니다.

열거형
STATE_UNSPECIFIED 지정되지 않음.
INITIALIZING 요청 처리를 준비 중입니다.
PROCESSING 요청이 활발히 처리되고 있습니다.
CANCELLING 사용자가 해당 작업에 대해 google.longrunning.Operations.CancelOperation을 호출한 후 요청이 취소되는 중입니다.
FINALIZING 요청이 처리되었으며 완료 단계에 있습니다.
SUCCESSFUL 요청이 성공적으로 완료되었습니다.
FAILED 요청 처리가 완료되었지만 오류가 발생했습니다.
CANCELLED 사용자가 google.longrunning.Operations.CancelOperation을 호출한 후 요청 취소가 완료되었습니다.

진전

특정 측정항목의 진행 상황을 측정합니다.

필드
work_completed

int64

완료된 작업량에 대한 추정치입니다. 이는 work_estimated 보다 클 수 있습니다.

work_estimated

int64

수행해야 할 작업량에 대한 추정치입니다. 작업 견적을 사용할 수 없는 경우 0입니다. 작업 진행에 따라 변경될 수 있습니다.