이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Package google.firestore.admin.v1beta1

색인

FirestoreAdmin(인터페이스)
CreateIndexRequest(메시지)
DeleteIndexRequest(메시지)
ExportDocumentsMetadata(메시지)
ExportDocumentsRequest(메시지)
ExportDocumentsResponse(메시지)
GetIndexRequest(메시지)
ImportDocumentsMetadata(메시지)
ImportDocumentsRequest(메시지)
Index(메시지)
Index.State(열거형)
IndexField(메시지)
IndexField.Mode(열거형)
IndexOperationMetadata(메시지)
IndexOperationMetadata.OperationType(열거형)
ListIndexesRequest(메시지)
ListIndexesResponse(메시지)
LocationMetadata(메시지)
OperationState(열거형)
Progress(메시지)

FirestoreAdmin

Cloud Firestore Admin API입니다.

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

개념

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

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

서비스

색인

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

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

메타데이터

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

작업

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

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

완료된 작업은 삭제되어 더 이상 작업 모음에 포함되지 않도록 삭제할 수 있습니다.

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

CreateIndex

CreateIndex
`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 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

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

DeleteIndex

DeleteIndex
`rpc DeleteIndex(DeleteIndexRequest) returns (Empty)` 색인을 삭제합니다. 승인 범위 다음 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

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

ExportDocuments

ExportDocuments
`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 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

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

GetIndex

GetIndex
`rpc GetIndex(GetIndexRequest) returns (Index)` 색인을 가져옵니다. 승인 범위 다음 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

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

ImportDocuments

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` 자세한 내용은 인증 개요를 참조하세요.

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

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

ListIndexes

ListIndexes
`rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)` 지정된 필터와 일치하는 색인을 나열합니다. 승인 범위 다음 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

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

CreateIndexRequest

FirestoreAdmin.CreateIndex의 요청입니다.

입력란

입력란
`parent`	`string` 이 색인을 적용할 데이터베이스의 이름입니다. 예: `projects/{project_id}/databases/{database_id}`
`index`	`Index` 만들 색인입니다. 이름 및 상태 필드는 출력 전용이며 무시됩니다. 특정 단일 필드 색인은 만들거나 삭제할 수 없습니다.

parent

string

이 색인을 적용할 데이터베이스의 이름입니다. 예: projects/{project_id}/databases/{database_id}

index

Index

만들 색인입니다. 이름 및 상태 필드는 출력 전용이며 무시됩니다. 특정 단일 필드 색인은 만들거나 삭제할 수 없습니다.

DeleteIndexRequest

FirestoreAdmin.DeleteIndex의 요청입니다.

입력란

입력란
`name`	`string` 색인 이름입니다. 예: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

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

ExportDocumentsMetadata

ExportDocuments 작업의 메타데이터입니다.

입력란
`start_time`	`Timestamp` 작업에서 작업이 시작된 시간입니다.
`end_time`	`Timestamp` 작업이 성공적으로 종료된 시간입니다. 작업이 아직 활성 상태이면 설정 해제합니다.
`operation_state`	`OperationState` 내보내기 작업의 상태입니다.
`progress_documents`	`Progress` 처리된 문서 수의 추정치입니다.
`progress_bytes`	`Progress` 처리된 바이트의 추정값입니다.
`collection_ids[]`	`string` 내보내는 컬렉션 ID입니다.
`output_uri_prefix`	`string` 항목을 내보낼 위치입니다.

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

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

ExportDocumentsResponse

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

입력란

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

output_uri_prefix

string

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

GetIndexRequest

FirestoreAdmin.GetIndex의 요청입니다.

입력란

입력란
`name`	`string` 색인의 이름입니다. 예: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

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

ImportDocumentsMetadata

ImportDocuments 작업의 메타데이터입니다.

입력란
`start_time`	`Timestamp` 작업에서 작업이 시작된 시간입니다.
`end_time`	`Timestamp` 작업이 성공적으로 종료된 시간입니다. 작업이 아직 활성 상태이면 설정 해제합니다.
`operation_state`	`OperationState` 가져오기 작업의 상태입니다.
`progress_documents`	`Progress` 처리된 문서 수의 추정치입니다.
`progress_bytes`	`Progress` 처리된 바이트의 추정값입니다.
`collection_ids[]`	`string` 가져오는 컬렉션 ID입니다.
`input_uri_prefix`	`string` 가져오는 문서의 위치입니다.

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.v1beta1.ExportDocumentsResponse.output_uri_prefix`를 참조하세요.

name

string

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

collection_ids[]

string

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

input_uri_prefix

string

내보낸 파일의 위치입니다. 성공적으로 완료된 내보내기의 ExportDocumentsResponse의 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`	색인을 생성 중이지만 문제가 발생했습니다. 색인에 대한 활성 장기 실행 작업이 없으며 가장 최근에 완료된 장기 실행 작업이 실패했습니다. 문서를 작성할 때는 색인이 업데이트되지 않습니다. 일부 색인 데이터가 있을 수 있습니다.

IndexField

색인의 필드입니다.

입력란

입력란
`field_path`	`string` 필드의 경로입니다. [google.firestore.v1beta1.Document.fields][fields]에 설명된 필드 경로 사양과 일치해야 합니다. 특수 필드 경로 `__name__`는 단독으로 또는 경로 끝에 사용할 수 있습니다. `__type__`는 경로 끝에서만 사용할 수 있습니다.
`mode`	`Mode` 필드의 모드입니다.

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입니다. 취소가 진행 중인 경우 취소됨은 true이지만 `google.longrunning.Operation.done`는 false입니다.
`document_progress`	`Progress` 문서 수로 측정된 기존 작업의 진행률입니다.

OperationType

색인 작업 유형입니다.

열거형
`OPERATION_TYPE_UNSPECIFIED`	지정되지 않았습니다. 서버에서 설정하지 않습니다.
`CREATING_INDEX`	색인을 만드는 작업입니다. `CreateIndex` 호출로 시작됩니다.

ListIndexesRequest

FirestoreAdmin.ListIndexes의 요청입니다.

입력란
`parent`	`string` 데이터베이스 이름입니다. 예: `projects/{project_id}/databases/{database_id}`
`filter`	`string`
`page_size`	`int32` 표준 목록 페이지 크기입니다.
`page_token`	`string` 표준 목록 페이지 토큰입니다.

ListIndexesResponse

FirestoreAdmin.ListIndexes의 응답입니다.

입력란

입력란
`indexes[]`	`Index` 색인
`next_page_token`	`string` 표준 목록 다음 페이지 토큰입니다.

indexes[]

Index

색인

next_page_token

string

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

LocationMetadata

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

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

OperationState

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

열거형
`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입니다. 업무 진행에 따라 변경될 수 있습니다.

work_completed

int64

완료된 작업량의 추정치입니다. work_estimated보다 클 수도 있습니다.

work_estimated

int64

수행해야 할 작업량의 추정치. 작업 추정치를 사용할 수 없는 경우 0입니다. 업무 진행에 따라 변경될 수 있습니다.