Package google.firestore.admin.v1beta1

Индекс

Администратор Firestore

API администратора Cloud Firestore.

Этот API предоставляет несколько административных услуг для Cloud Firestore.

Концепции

Проект, база данных, пространство имен, коллекция и документ используются так, как определено в API Google Cloud Firestore.

Операция: Операция представляет собой работу, выполняемую в фоновом режиме.

Услуги

Индекс

Служба индексирования управляет индексами Cloud Firestore.

Создание индекса выполняется асинхронно. Ресурс Operation создается для каждой такой асинхронной операции. Состояние операции (включая любые обнаруженные ошибки) можно запросить через ресурс Operation.

Метаданные

Предоставляет метаданные и статистическую информацию о данных в 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. Недавние обновления документов могут не быть отражены при экспорте. Экспорт происходит в фоновом режиме, и его ход можно отслеживать и управлять с помощью созданного ресурса Operation. Вывод экспорта можно использовать только после завершения соответствующей операции. Если операция экспорта отменена до завершения, в облачном хранилище Google могут остаться частичные данные.

Области авторизации

Требуется одна из следующих областей 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. Существующие документы с таким же именем перезаписываются. Импорт происходит в фоновом режиме, и его ход можно отслеживать и управлять с помощью созданного ресурса Operation. Если операция 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

Для получения дополнительной информации см. Обзор аутентификации .

CreateIndexRequest

Запрос 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}

ЭкспортДокументыМетаданные

Метаданные для операций ExportDocuments.

Поля
start_time

Timestamp

Время начала работ по операции.

end_time

Timestamp

Время завершения операции, успешное или нет. Не установлено, если операция все еще активна.

operation_state

OperationState

Состояние экспортной операции.

progress_documents

Progress

Оценка количества обработанных документов.

progress_bytes

Progress

Оценка количества обработанных байтов.

collection_ids[]

string

Идентификаторы каких коллекций экспортируются.

output_uri_prefix

string

Куда экспортируются сущности.

ЭкспортДокументыЗапрос

Запрос FirestoreAdmin.ExportDocuments .

Поля
name

string

База данных для экспорта. Должно иметь форму: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Идентификаторы каких коллекций экспортировать. Не указано означает все коллекции.

output_uri_prefix

string

Выходной URI. В настоящее время поддерживаются только URI Google Cloud Storage в форме: gs://BUCKET_NAME[/NAMESPACE_PATH] , где 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 (этот проект или другой проект) после успешного завершения операции.

GetIndexRequest

Запрос 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

Идентификаторы каких коллекций импортируются.

input_uri_prefix

string

Местоположение импортируемых документов.

Запрос импорта документов

Запрос FirestoreAdmin.ImportDocuments .

Поля
name

string

База данных для импорта. Должно иметь форму: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Идентификаторы каких коллекций импортировать. Не указано — все коллекции, включенные в импорт.

input_uri_prefix

string

Расположение экспортированных файлов. Он должен соответствовать выходному_uri_prefix в ExportDocumentsResponse из успешно завершенного экспорта. См.: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix .

Индекс

Определение индекса.

Поля
name

string

Имя ресурса индекса. Только вывод.

collection_id

string

Идентификатор коллекции, к которой применяется этот индекс. Необходимый.

fields[]

IndexField

Поля для индексирования.

state

State

Состояние индекса. Только вывод.

Состояние

Состояние индекса. Во время создания индекса индекс будет находиться в состоянии CREATING . Если индекс создан успешно, он перейдет в состояние READY . Если индекс не может быть создан, он перейдет в состояние ERROR .

Перечисления
STATE_UNSPECIFIED Состояние не указано.
CREATING Индекс создается. Для индекса выполняется активная длительная операция. Индекс обновляется при написании документа. Могут существовать некоторые индексные данные.
READY Индекс готов к использованию. Индекс обновляется при написании документа. Индекс полностью заполняется из всех сохраненных документов, к которым он применяется.
ERROR Индекс создавался, но что-то пошло не так. Для индекса нет активных длительных операций, а последняя завершенная длительная операция завершилась неудачно. Индекс не обновляется при написании документа. Могут существовать некоторые индексные данные.

ИндексФилд

Поле индекса.

Поля
field_path

string

Путь поля. Должен соответствовать спецификации пути к полю, описанной в [google.firestore.v1beta1.Document.fields][fields]. Специальное поле path __name__ может использоваться само по себе или в конце пути. __type__ можно использовать только в конце пути.

mode

Mode

Режим поля.

Режим

Режим определяет, как индексируется поле.

Перечисления
MODE_UNSPECIFIED Режим не указан.
ASCENDING Значения поля индексируются для поддержки упорядочивания в порядке возрастания, а также запроса по <, >, <=, >= и =.
DESCENDING Значения поля индексируются для поддержки упорядочивания в порядке убывания, а также запроса по <, >, <=, >= и =.
ARRAY_CONTAINS Значения массива поля индексируются для поддержки членства с помощью запросов ARRAY_CONTAINS.

ИндексОперацияМетаданные

Метаданные для индексных операций. Эти метаданные заполняют поле метаданных 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

True, если google.longrunning.Operation была отменена. Если отмена еще продолжается, то значение canceled будет true, а google.longrunning.Operation.done — false.

document_progress

Progress

Прогресс существующей операции измеряется количеством документов.

Тип операции

Тип индексной операции.

Перечисления
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

Стандартный токен следующей страницы списка.

Метаданные местоположения

Этот тип не имеет полей.

Сообщение метаданных для 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

Оценка объема работ, которые необходимо выполнить. Ноль, если смета работ недоступна. Может меняться по ходу работы.