Package google.firestore.admin.v1

Индекс

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

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

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

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

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

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

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

Коллекция Operations предоставляет запись действий, выполненных для указанного проекта (включая любые текущие операции). Операции создаются не напрямую, а посредством вызовов других коллекций или ресурсов.

Выполненную операцию можно удалить, чтобы она больше не отображалась как часть коллекции операций. Операции вывозятся через 30 дней. По умолчанию ListOperations возвращает только текущие и неудачные операции. Чтобы вывести список завершенных операций, выполните запрос ListOperations с фильтром done: true .

Операции создаются службой FirestoreAdmin , но доступ к ним осуществляется через службу google.longrunning.Operations .

Создание расписания резервного копирования

rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )

Создает расписание резервного копирования в базе данных. Для базы данных можно настроить не более двух графиков резервного копирования: одно ежедневное и одно еженедельное.

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

Требуется одна из следующих областей OAuth:

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

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

Создать базу данных

rpc CreateDatabase( CreateDatabaseRequest ) returns ( Operation )

Создайте базу данных.

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

Требуется одна из следующих областей OAuth:

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

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

Создатьиндекс

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

Создает составной индекс. Это возвращает google.longrunning.Operation , который можно использовать для отслеживания статуса создания. Метаданные операции будут иметь тип IndexOperationMetadata .

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

Требуется одна из следующих областей OAuth:

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

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

Удалить резервную копию

rpc DeleteBackup( DeleteBackupRequest ) returns ( Empty )

Удаляет резервную копию.

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

Требуется одна из следующих областей OAuth:

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

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

Удалить резервное расписание

rpc DeleteBackupSchedule( DeleteBackupScheduleRequest ) returns ( Empty )

Удаляет расписание резервного копирования.

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

Требуется одна из следующих областей OAuth:

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

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

Удалить базу данных

rpc DeleteDatabase( DeleteDatabaseRequest ) returns ( Operation )

Удаляет базу данных.

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

Требуется одна из следующих областей 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 могут остаться частичные данные.

Дополнительные сведения о поведении экспорта и формате вывода см. на странице https://cloud.google.com/firestore/docs/manage-data/export-import .

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

Требуется одна из следующих областей OAuth:

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

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

Получить резервную копию

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

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

Получить базу данных

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

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

Импорт документов

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

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

ListBackupSchedules

rpc ListBackupSchedules( ListBackupSchedulesRequest ) returns ( ListBackupSchedulesResponse )

Список расписаний резервного копирования.

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

Требуется одна из следующих областей OAuth:

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

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

Список резервных копий

rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )

Перечисляет все резервные копии.

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

Требуется одна из следующих областей OAuth:

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

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

Список баз данных

rpc ListDatabases( ListDatabasesRequest ) returns ( ListDatabasesResponse )

Перечислите все базы данных в проекте.

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

Требуется одна из следующих областей OAuth:

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

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

Список полей

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

Перечисляет конфигурацию полей и метаданные для этой базы данных.

В настоящее время FirestoreAdmin.ListFields поддерживает только те поля списка, которые были явно переопределены. Чтобы выполнить этот запрос, вызовите FirestoreAdmin.ListFields с фильтром, установленным на indexConfig.usesAncestorConfig:false или ttlConfig:* .

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

Требуется одна из следующих областей 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

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

Восстановить базу данных

rpc RestoreDatabase( RestoreDatabaseRequest ) returns ( Operation )

Создает новую базу данных путем восстановления из существующей резервной копии.

Новая база данных должна находиться в том же облачном регионе или расположении в нескольких регионах, что и существующая резервная копия. Это ведет себя аналогично [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], за исключением того, что вместо создания новой пустой базы данных создается новая база данных с типом базы данных, конфигурацией индекса и документами из существующей резервной копии.

long-running operation можно использовать для отслеживания хода восстановления, при этом типом поля metadata операции является RestoreDatabaseMetadata . Тип responseDatabase , если восстановление прошло успешно. Новая база данных недоступна для чтения и записи до завершения LRO.

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

Требуется одна из следующих областей OAuth:

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

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

ОбновлениеBackupSchedule

rpc UpdateBackupSchedule( UpdateBackupScheduleRequest ) returns ( BackupSchedule )

Обновляет расписание резервного копирования.

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

Требуется одна из следующих областей OAuth:

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

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

Обновление базы данных

rpc UpdateDatabase( UpdateDatabaseRequest ) returns ( Operation )

Обновляет базу данных.

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

Требуется одна из следующих областей OAuth:

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

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

Обновить поле

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

Обновляет конфигурацию поля. В настоящее время обновления полей применяются только к конфигурации индекса с одним полем. Однако вызовы FirestoreAdmin.UpdateField должны предоставлять маску поля, чтобы избежать изменения любой конфигурации, о которой вызывающая сторона не знает. Маска поля должна быть указана как: { paths: "index_config" } .

Этот вызов возвращает google.longrunning.Operation , который можно использовать для отслеживания статуса обновления поля. Метаданные для операции будут иметь тип FieldOperationMetadata .

Чтобы настроить параметры поля по умолчанию для базы данных, используйте специальное Field с именем ресурса: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* .

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

Требуется одна из следующих областей 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

Только вывод. Созданный системой UUID4 для базы данных Firestore, из которой сделана резервная копия.

snapshot_time

Timestamp

Только вывод. На данный момент резервная копия содержит внешне согласованную копию базы данных.

expire_time

Timestamp

Только вывод. Временная метка истечения срока действия этой резервной копии.

state

State

Только вывод. Текущее состояние резервной копии.

Состояние

Укажите текущее состояние резервной копии.

Перечисления
STATE_UNSPECIFIED Состояние не указано.
CREATING Ожидающая резервная копия все еще создается. В этом состоянии операции по резервному копированию будут отклонены.
READY Резервная копия завершена и готова к использованию.
NOT_AVAILABLE Резервная копия в данный момент недоступна.

Расписание резервного копирования

Расписание резервного копирования для базы данных Cloud Firestore.

Этот ресурс принадлежит базе данных, резервную копию которой он создает, и удаляется вместе с базой данных. Однако настоящие резервные копии не являются таковыми.

Поля
name

string

Только вывод. Уникальный идентификатор расписания резервного копирования во всех расположениях и базах данных данного проекта.

Это будет назначено автоматически.

Формат: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

create_time

Timestamp

Только вывод. Временная метка, в которую это расписание резервного копирования было создано и вступило в силу.

До этого времени для этого расписания не будут создаваться резервные копии.

update_time

Timestamp

Только вывод. Отметка времени последнего обновления расписания резервного копирования. Когда расписание резервного копирования создается впервые, это то же самое, что и create_time.

retention

Duration

В какое относительное время в будущем по сравнению со временем создания резервную копию следует удалить, например, хранить резервные копии в течение 7 дней.

Максимальный поддерживаемый период хранения — 14 недель.

recurrence поля объединения. Одно из полей, указывающее, когда будет создаваться резервное копирование. recurrence может быть только одним из следующих:
daily_recurrence

DailyRecurrence

Для расписания, которое работает ежедневно.

weekly_recurrence

WeeklyRecurrence

Для расписания, которое выполняется еженедельно в определенный день.

CreateBackupScheduleRequest

Запрос FirestoreAdmin.CreateBackupSchedule .

Поля
parent

string

Необходимый. Родительская база данных.

Формат projects/{project}/databases/{database}

backup_schedule

BackupSchedule

Необходимый. Расписание резервного копирования, которое необходимо создать.

Создатьбазу данныхметаданные

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

Метаданные, относящиеся к операции создания базы данных.

Создать запрос к базе данных

Запрос для FirestoreAdmin.CreateDatabase .

Поля
parent

string

Необходимый. Родительское имя формы projects/{project_id}

database

Database

Необходимый. База данных, которую необходимо создать.

database_id

string

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

Это значение должно содержать от 4 до 63 символов. Допустимые символы: /[az][0-9]-/, где первый символ — буква, а последний — буква или цифра. Не должен быть UUID типа /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

Идентификатор базы данных «(по умолчанию)» также действителен.

CreateIndexRequest

Запрос FirestoreAdmin.CreateIndex .

Поля
parent

string

Необходимый. Родительское имя формы projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

Необходимый. Составной индекс, который нужно создать.

ЕжедневноПовторение

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

Представляет повторяющийся график, который выполняется каждый день.

Часовой пояс — UTC.

База данных

База данных Cloud Firestore.

Поля
name

string

Имя ресурса базы данных. Формат: projects/{project}/databases/{database}

uid

string

Только вывод. Созданный системой UUID4 для этой базы данных.

create_time

Timestamp

Только вывод. Временная метка создания этой базы данных. Базы данных, созданные до 2016 года, не заполняют create_time.

update_time

Timestamp

Только вывод. Временная метка последнего обновления этой базы данных. Обратите внимание, что сюда входят только обновления ресурса базы данных, а не данные, содержащиеся в базе данных.

delete_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 используется в сочетании с идентификатором проекта (" ~ ") для создания идентификатора приложения, который возвращается из API-интерфейсов Cloud Datastore в средах выполнения первого поколения Google App Engine.

Это значение может быть пустым, и в этом случае идентификатор приложения, используемый для ключей в кодировке URL, — это project_id (например: foo вместо v~foo).

delete_protection_state

DeleteProtectionState

Состояние защиты от удаления базы данных.

cmek_config

CmekConfig

Необязательный. Присутствие указывает на то, что CMEK включен для этой базы данных.

previous_id

string

Только вывод. Предыдущий идентификатор базы данных ресурса базы данных. Это поле заполняется только для удаленных баз данных.

etag

string

Эта контрольная сумма вычисляется сервером на основе значений других полей и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

AppEngineIntegrationMode

Тип режима интеграции App Engine.

Перечисления
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Не используется.
ENABLED Если приложение App Engine существует в том же регионе, что и эта база данных, конфигурация App Engine повлияет на эту базу данных. Это включает в себя отключение приложения и базы данных, а также отключение записи в базу данных.
DISABLED

App Engine не влияет на способность этой базы данных обслуживать запросы.

Это настройка по умолчанию для баз данных, созданных с помощью Firestore API.

CmekConfig

Конфигурация CMEK (ключ шифрования, управляемый клиентом) для базы данных Firestore. Если он отсутствует, база данных защищена ключом шифрования Google по умолчанию.

Поля
kms_key_name

string

Необходимый. Для шифрования можно использовать только ключи, находящиеся в том же месте, что и эта база данных.

Для мультирегиона nam5 Firestore это соответствует мультирегиону Cloud KMS us. Для мультирегионального eur3 Firestore это соответствует мультирегиональному сервису Cloud KMS в Европе. См. https://cloud.google.com/kms/docs/locations .

Ожидаемый формат: projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} .

active_key_version[]

string

Только вывод. Используемые в настоящее время версии ключей KMS . Во время ротации ключей может использоваться несколько версий ключей.

Ожидаемый формат: projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} .

Режим параллелизма

Тип режима управления параллелизмом для транзакций.

Перечисления
CONCURRENCY_MODE_UNSPECIFIED Не используется.
OPTIMISTIC По умолчанию используйте оптимистичный контроль параллелизма. Этот режим доступен для баз данных Cloud Firestore.
PESSIMISTIC

По умолчанию используйте пессимистическое управление параллелизмом. Этот режим доступен для баз данных Cloud Firestore.

Это настройка по умолчанию для Cloud Firestore.

OPTIMISTIC_WITH_ENTITY_GROUPS

По умолчанию используйте оптимистичный контроль параллелизма с группами сущностей.

Это единственный доступный режим для Cloud Datastore.

Этот режим также доступен для Cloud Firestore с режимом хранилища данных, но не рекомендуется.

Тип базы данных

Тип базы данных. См. https://cloud.google.com/datastore/docs/firestore-or-datastore для получения информации о том, как выбрать.

Изменение режима разрешено только в том случае, если база данных пуста.

Перечисления
DATABASE_TYPE_UNSPECIFIED Значение по умолчанию. Это значение используется, если тип базы данных опущен.
FIRESTORE_NATIVE Основной режим Firestore
DATASTORE_MODE Firestore в режиме хранилища данных.

Делепротетектионстате

Состояние защиты базы данных от удаления.

Перечисления
DELETE_PROTECTION_STATE_UNSPECIFIED Значение по умолчанию. Не указан тип защиты от удаления
DELETE_PROTECTION_DISABLED Защита от удаления отключена
DELETE_PROTECTION_ENABLED Защита от удаления включена

Пойнтинтимерековериенаблемент

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

Перечисления
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Не используется.
POINT_IN_TIME_RECOVERY_ENABLED

Чтение поддерживается для выбранных версий данных за последние 7 дней:

  • Считывает любую временную метку за последний час.
  • Считывает 1-минутные снимки за 1 час и в течение 7 дней.

version_retention_period и earliest_version_time можно использовать для определения поддерживаемых версий.

POINT_IN_TIME_RECOVERY_DISABLED Чтение поддерживается для любой версии данных за последний час.

Удалить резервный запрос

Запрос FirestoreAdmin.DeleteBackup .

Поля
name

string

Необходимый. Имя резервной копии, которую нужно удалить.

формат: projects/{project}/locations/{location}/backups/{backup} .

Удалитьбаккуппланерекуест

Запрос для [FirestoreAdmin.DeleteBackupSchedules][].

Поля
name

string

Необходимый. Имя расписания резервного копирования.

Формат projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Удалитьметаданные базы данных

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

Метаданные, относящиеся к операции удаления базы данных.

Удалить запрос базы данных

Запрос FirestoreAdmin.DeleteDatabase .

Поля
name

string

Необходимый. Имя формы projects/{project_id}/databases/{database_id}

etag

string

Текущий тег базы данных. Если указан etag, который не соответствует текущему etag базы данных, удаление будет заблокировано и будет возвращена ошибка FAILED_PRECONDITION.

Удалитьиндексрекуест

Запрос FirestoreAdmin.DeleteIndex .

Поля
name

string

Необходимый. Имя формы projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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

Метаданные для google.longrunning.Operation results из FirestoreAdmin.ExportDocuments .

Поля
start_time

Timestamp

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

end_time

Timestamp

Время завершения этой операции. Будет отключено, если операция еще продолжается.

operation_state

OperationState

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

progress_documents

Progress

Ход этой операции в документах.

progress_bytes

Progress

Ход выполнения этой операции в байтах.

collection_ids[]

string

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

output_uri_prefix

string

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

namespace_ids[]

string

Какие идентификаторы пространства имен экспортируются.

snapshot_time

Timestamp

Временная метка, соответствующая экспортируемой версии базы данных. Если не указано, нет никаких гарантий относительно согласованности экспортируемых документов.

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

Запрос 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 представляет собой сегмент (без пути в пространстве имен), префикс будет создан на основе времени начала.

namespace_ids[]

string

Пустой список представляет все пространства имен. Это предпочтительное использование для баз данных, которые не используют пространства имен.

Пустой строковый элемент представляет пространство имен по умолчанию. Это следует использовать, если база данных имеет данные в пространствах имен, отличных от заданных по умолчанию, но не хочет их включать. Каждое пространство имен в этом списке должно быть уникальным.

snapshot_time

Timestamp

Временная метка, соответствующая версии экспортируемой базы данных. Временная метка должна быть в прошлом, округлена до минуты и не старше, чем earliestVersionTime . Если указано, то экспортированные документы будут представлять собой согласованное представление базы данных в указанное время. В противном случае нет никаких гарантий относительно целостности экспортируемых документов.

ЭкспортДокументыОтвет

Возвращается в поле ответа google.longrunning.Operation .

Поля
output_uri_prefix

string

Расположение выходных файлов. Это можно использовать для начала импорта в Cloud Firestore (этот проект или другой проект) после успешного завершения операции.

Поле

Представляет одно поле в базе данных.

Поля сгруппированы по «Группе коллекций», которая представляет все коллекции в базе данных с одинаковым идентификатором.

Поля
name

string

Необходимый. Имя поля формы projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Путь к полю может представлять собой простое имя поля, например, address , или путь к полям в пределах карты_значение, например, 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 named Address.city , not the map key in the field адрес . `*` represents a field named *`, а не любое поле.

Специальное Field содержит настройки индексации по умолчанию для всех полей. Имя ресурса этого поля: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Индексы, определенные в этом Field , будут применяться ко всем полям, которые не имеют собственной конфигурации индекса Field .

index_config

IndexConfig

Конфигурация индекса для этого поля. Если значение не установлено, индексация полей вернется к конфигурации, определенной параметром ancestor_field . Чтобы явно удалить все индексы для этого поля, укажите конфигурацию индекса с пустым списком индексов.

ttl_config

TtlConfig

Конфигурация TTL для этого Field . Установка или снятие этой настройки включит или отключит TTL для документов, имеющих это Field .

ИндексКонфиг

Конфигурация индекса для этого поля.

Поля
indexes[]

Index

Индексы, поддерживаемые для этого поля.

uses_ancestor_config

bool

Только вывод. Если установлено значение true, конфигурация индекса Field задается на основе конфигурации, указанной в поле ancestor_field . Если значение равно false, конфигурация индекса Field определяется явно.

ancestor_field

string

Только вывод. Указывает имя ресурса Field , из которого задается конфигурация индекса этого поля (когда uses_ancestor_config имеет значение true) или из которого оно было бы установлено, если бы это поле не имело конфигурации индекса (когда uses_ancestor_config имеет значение false).

reverting

bool

Только вывод. Если установлено значение true, конфигурация индекса Field находится в процессе восстановления. После завершения конфигурация индекса перейдет в то же состояние, что и поле, указанное в ancestor_field , после чего uses_ancestor_config будет иметь true , а reverting будет false .

Ттлконфиг

Конфигурация TTL (срока жизни) для документов, у которых установлено это Field .

Сохранение значения временной метки в поле с поддержкой TTL будет рассматриваться как абсолютное время истечения срока действия документа. Значения временных меток в прошлом указывают на то, что срок действия документа истекает немедленно. Использование любого другого типа данных или отсутствие поля отключит срок действия отдельного документа.

Поля
state

State

Только вывод. Состояние конфигурации TTL.

Состояние

Состояние применения конфигурации TTL ко всем документам.

Перечисления
STATE_UNSPECIFIED Состояние не указано или неизвестно.
CREATING TTL применяется. Существует активная длительная операция по отслеживанию изменений. Вновь написанные документы будут иметь TTL по запросу. Запрошенные TTL для существующих документов все еще обрабатываются. Когда TTL всех существующих документов будут обработаны, состояние перейдет в «АКТИВНО».
ACTIVE TTL активен для всех документов.
NEEDS_REPAIR Конфигурацию TTL невозможно включить для всех существующих документов. Для вновь написанных документов по-прежнему будет применяться срок жизни. LRO вернулся, когда последняя попытка включить TTL для этого Field не удалась, и может содержать более подробную информацию.

ПолеОперацияМетаданные

Метаданные для google.longrunning.Operation — результаты FirestoreAdmin.UpdateField .

Поля
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.

ИндексКонфигДельта

Информация об изменении конфигурации индекса.

Поля
change_type

ChangeType

Указывает, как изменяется индекс.

index

Index

Индекс изменяется.

Тип изменения

Указывает, как изменяется индекс.

Перечисления
CHANGE_TYPE_UNSPECIFIED Тип изменения не указан и не известен.
ADD Добавляется индекс одного поля.
REMOVE Индекс одного поля удаляется.

Ттлконфигдельта

Информация об изменении конфигурации TTL.

Поля
change_type

ChangeType

Указывает, как изменяется конфигурация TTL.

Тип изменения

Указывает, как меняется конфигурация 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}

Импорт документовМетаданные

Метаданные для google.longrunning.Operation results из FirestoreAdmin.ImportDocuments .

Поля
start_time

Timestamp

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

end_time

Timestamp

Время завершения этой операции. Будет отключено, если операция еще продолжается.

operation_state

OperationState

Состояние операции импорта.

progress_documents

Progress

Ход этой операции в документах.

progress_bytes

Progress

Ход выполнения этой операции в байтах.

collection_ids[]

string

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

input_uri_prefix

string

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

namespace_ids[]

string

Какие идентификаторы пространства имен импортируются.

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

Запрос FirestoreAdmin.ImportDocuments .

Поля
name

string

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

collection_ids[]

string

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

input_uri_prefix

string

Расположение экспортированных файлов. Он должен соответствовать выходному_uri_prefix в ExportDocumentsResponse из успешно завершенного экспорта. См.: 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

Индексы с указанной областью запроса коллекции позволяют выполнять запросы к коллекции, которая является дочерней по отношению к определенному документу, указанному во время запроса, и имеет тот же идентификатор коллекции.

Индексы с указанной областью запроса группы коллекций позволяют выполнять запросы ко всем коллекциям, происходящим из определенного документа, указанного во время запроса, и которые имеют тот же идентификатор коллекции, что и этот индекс.

api_scope

ApiScope

Область API, поддерживаемая этим индексом.

fields[]

IndexField

Поля, поддерживаемые этим индексом.

Для составных индексов требуется минимум 2 и максимум 100 полей. Последняя запись поля всегда относится к пути к полю __name__ . Если при создании __name__ не было указано в качестве последнего поля, оно будет добавлено автоматически в том же направлении, что и последнее определенное поле. Если последнее поле в составном индексе не является направленным, __name__ будет упорядочено по возрастанию (если не указано иное).

Для индексов с одним полем это всегда будет ровно одна запись с путем к полю, равным пути к связанному полю.

state

State

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

Апископ

Область API определяет API (Firestore Native или Firestore в режиме хранилища данных), которые поддерживаются для запросов.

Перечисления
ANY_API Индекс может использоваться только API запросов Firestore Native. Это значение по умолчанию.
DATASTORE_MODE_API Индекс может использоваться только API запросов Firestore в режиме хранилища данных.

ИндексФилд

Поле в индексе. Field_path описывает, какое поле индексируется, value_mode описывает, как индексируется значение поля.

Поля
field_path

string

Можно имя . Для индексов с одним полем оно должно совпадать с именем поля или может быть опущено.

Поле объединения value_mode . Как индексируется значение поля. value_mode может быть только одним из следующих:
order

Order

Указывает, что это поле поддерживает упорядочивание по указанному порядку или сравнение с использованием =, !=, <, <=, >, >=.

array_config

ArrayConfig

Указывает, что это поле поддерживает операции с array_value s.

vector_config

VectorConfig

Указывает, что это поле поддерживает операции ближайшего соседа и расстояния над вектором.

ArrayConfig

Поддерживаемые конфигурации значений массива.

Перечисления
ARRAY_CONFIG_UNSPECIFIED Индекс не поддерживает дополнительные запросы к массиву.
CONTAINS Индекс поддерживает запросы на включение массива.

Заказ

Поддерживаемые заказы.

Перечисления
ORDER_UNSPECIFIED Порядок не указан. Не верный вариант.
ASCENDING Поле упорядочено по возрастанию значения поля.
DESCENDING Поле упорядочено по убыванию значения поля.

ВекторКонфиг

Конфигурация индекса для поддержки операций поиска векторов

Поля
dimension

int32

Необходимый. Векторное измерение, к которому применяется эта конфигурация.

Результирующий индекс будет включать только векторы этого измерения и может использоваться для поиска векторов того же измерения.

type поля объединения. Тип используемого индекса. type может быть только одним из следующих:
flat

FlatIndex

Указывает, что векторный индекс является плоским индексом.

Флэтиндекс

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

Индекс, который хранит векторы в плоской структуре данных и поддерживает исчерпывающий поиск.

Область запроса

Область запроса определяет область, в которой выполняется запрос. Это указывается в поле from структурированного запроса.

Перечисления
QUERY_SCOPE_UNSPECIFIED Область запроса не указана. Не верный вариант.
COLLECTION Индексы с указанной областью запроса коллекции позволяют выполнять запросы к коллекции, которая является дочерней частью определенного документа, указанного во время запроса, и имеет идентификатор коллекции, указанный индексом.
COLLECTION_GROUP Индексы с указанной областью запроса группы коллекций позволяют выполнять запросы ко всем коллекциям, идентификатор коллекции которых указан в индексе.
COLLECTION_RECURSIVE Включите в индекс всех предков коллекций. Доступно только для баз данных в режиме хранилища данных.

Состояние

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

Перечисления
STATE_UNSPECIFIED Государство неуточено.
CREATING Индекс создается. Существует активная долгосрочная операция для индекса. Индекс обновляется при написании документа. Некоторые данные индекса могут существовать.
READY Индекс готов к использованию. Индекс обновляется при написании документа. Индекс полностью заполнен всеми хранящимися документами, к которым он применяется.
NEEDS_REPAIR Индекс создавался, но что -то пошло не так. Не существует активной длительной операции для индекса, и последняя завершенная долгосрочная операция не удалась. Индекс не обновляется при написании документа. Некоторые данные индекса могут существовать. Используйте API Google.LongRunning.Operations, чтобы определить, почему операция, которая в последний раз пыталась создать этот индекс, не удалась, а затем воссоздает индекс.

IndexoperationMetadata

Метаданные для google.longrunning.Operation Результаты FirestoreAdmin.CreateIndex .

Поля
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

Список локаций, из которых существующие резервные копии не смогли получить.

Вместо того, чтобы сбой всех запросов, когда одно местоположение недоступно, этот ответ возвращает частичный набор результатов и список мест, которые не могут быть достигнуты здесь. Запрос может быть повторно подходит к одному месту, чтобы получить конкретную ошибку.

ListDataBasasRequest

Запрос на перечисление баз данных Firestore во всех местах для проекта.

Поля
parent

string

Необходимый. Родительское имя формы projects/{project_id}

show_deleted

bool

Если это правда, также возвращает удаленные ресурсы.

ListDataBasasResponse

Список баз данных для проекта.

Поля
databases[]

Database

Базы данных в проекте.

unreachable[]

string

В случае, если данные об отдельных базах данных не могут быть перечислены, они будут записаны здесь.

Примером заявления может быть: Projects/some_project/locations/some_location Это может произойти, если облачная область, в которой находится база данных, в настоящее время недоступна. В этом случае мы не можем получить все детали о базе данных. Возможно, вы сможете получить более подробное сообщение об ошибке (или, возможно, получить ресурс), отправив запрос «получить» на ресурс или запрос «список» для конкретного местоположения.

ListFieldSrequest

Запрос на FirestoreAdmin.ListFields .

Поля
parent

string

Необходимый. Родительское имя формы projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

Фильтр для применения для перечисления результатов. В настоящее время FirestoreAdmin.ListFields поддерживает только поля листинга, которые были явно переопределены. Чтобы выдать этот запрос, позвоните FirestoreAdmin.ListFields с помощью фильтра, который включает в себя indexConfig.usesAncestorConfig:false или ttlConfig:* .

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 .

Операция

Описывает состояние операции.

Перечисления
OPERATION_STATE_UNSPECIFIED Не указано.
INITIALIZING Запрос готов к обработке.
PROCESSING Запрос активно обрабатывается.
CANCELLING Запрос находится в процессе отмены после пользователя под названием Google.longrunning.operations.canceloporation в операции.
FINALIZING Запрос был обработан и находится на этапе завершения.
SUCCESSFUL Запрос успешно завершился.
FAILED Запрос закончил обработан, но столкнулся с ошибкой.
CANCELLED Запрос закончил отменен после того, как пользователь под названием google.longrunning.operations.canceloporation.

Прогресс

Описывает прогресс операции. Единица работы является общей и должна интерпретироваться на основе того, где используется Progress .

Поля
estimated_work

int64

Объем работы по оценкам.

completed_work

int64

Объем работы завершился.

Restoredatabasemetadata

Метаданные для long-running operation по запросу [RestoredAtabase]

Поля
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

Необходимый. Идентификатор для использования для базы данных, который станет конечным компонентом имени ресурса базы данных. Этот идентификатор базы данных не должен быть связан с существующей базой данных.

Это значение должно быть 4-63 символами. Допустимых символов / [AZ] [0-9]- / с первым персонажем буквы и последней буквы или номера. Не должен быть uuid-like /[0-9a-f] {8} (-[0-9a-f] {4}) {3}-[0-9a-f] {12} /.

«(по умолчанию)» идентификатор базы данных также действителен.

Полевой source союза.

source может быть только одним из следующих:

backup

string

Резервное копирование, чтобы восстановить из. Должен быть из того же проекта, что и родитель.

Формат: projects/{project_id}/locations/{location}/backups/{backup}

UpdatebackupscheduleRequest

Запрос на FirestoreAdmin.UpdateBackupSchedule .

Поля
backup_schedule

BackupSchedule

Необходимый. Резервное расписание для обновления.

update_mask

FieldMask

Список полей для обновления.

Updatedatabasemetadata

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

Метаданные, связанные с операцией базы данных обновлений.

Обновленный atatabaseRequest

Запрос на FirestoreAdmin.UpdateDatabase .

Поля
database

Database

Необходимый. База данных для обновления.

update_mask

FieldMask

Список полей для обновления.

UpdateFieldRequest

Запрос на FirestoreAdmin.UpdateField .

Поля
field

Field

Необходимый. Поле для обновления.

update_mask

FieldMask

Маска, относительно поля. Если указано, только конфигурация, указанная этим Field_mask, будет обновлена ​​в поле.

Еженедельный рекурс

Представляет собой повторяющийся график, который работает в указанный день недели.

Часовой пояс - UTC.

Поля
day

DayOfWeek

День недели, чтобы бежать.

Day_of_week_unspecifified не допускается.