Package google.firestore.admin.v1

string

Только вывод. Уникальное имя ресурса резервной копии.

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

string

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

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

string

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

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

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

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

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

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

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

DeleteProtectionState

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

CmekConfig

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

string

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

string

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

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} .

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 базы данных, удаление будет заблокировано и будет возвращена ошибка FAILED_PRECONDITION.

string

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

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

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

string

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

string

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

Timestamp

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

string

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

string

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

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

string

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

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

Timestamp

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

string

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

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 .

IndexConfig

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

TtlConfig

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

Index

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

bool

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

string

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

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

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

string

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

string

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

string

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

string

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

string

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

string

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

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

string

Только вывод. Определенное сервером имя для этого индекса. Форма этого имени для составных индексов будет следующей: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Для индексов с одним полем это поле будет пустым.

QueryScope

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

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

ApiScope

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

IndexField

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

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

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

State

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

string

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

Order

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

ArrayConfig

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

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

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

Database

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

string

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

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

string

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

string

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

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

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

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

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

string

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

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

BackupSchedule

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

FieldMask

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

Database

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

FieldMask

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

Field

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

FieldMask

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

DayOfWeek

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

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