Índice
FirestoreAdmin
(interface)Backup
(mensagem)Backup.State
(enum)BackupSchedule
(mensagem)CreateBackupScheduleRequest
(mensagem)CreateDatabaseMetadata
(mensagem)CreateDatabaseRequest
(mensagem)CreateIndexRequest
(mensagem)DailyRecurrence
(mensagem)Database
(mensagem)Database.AppEngineIntegrationMode
(enum)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)Database.DeleteProtectionState
(enum)Database.PointInTimeRecoveryEnablement
(enum)DeleteBackupRequest
(mensagem)DeleteBackupScheduleRequest
(mensagem)DeleteDatabaseMetadata
(mensagem)DeleteDatabaseRequest
(mensagem)DeleteIndexRequest
(mensagem)ExportDocumentsMetadata
(mensagem)ExportDocumentsRequest
(mensagem)ExportDocumentsResponse
(mensagem)Field
(mensagem)Field.IndexConfig
(mensagem)Field.TtlConfig
(mensagem)Field.TtlConfig.State
(enum)FieldOperationMetadata
(mensagem)FieldOperationMetadata.IndexConfigDelta
(mensagem)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(mensagem)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetBackupRequest
(mensagem)GetBackupScheduleRequest
(mensagem)GetDatabaseRequest
(mensagem)GetFieldRequest
(mensagem)GetIndexRequest
(mensagem)ImportDocumentsMetadata
(mensagem)ImportDocumentsRequest
(mensagem)Index
(mensagem)Index.ApiScope
(enum)Index.IndexField
(mensagem)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(mensagem)ListBackupSchedulesRequest
(mensagem)ListBackupSchedulesResponse
(mensagem)ListBackupsRequest
(mensagem)ListBackupsResponse
(mensagem)ListDatabasesRequest
(mensagem)ListDatabasesResponse
(mensagem)ListFieldsRequest
(mensagem)ListFieldsResponse
(mensagem)ListIndexesRequest
(mensagem)ListIndexesResponse
(mensagem)LocationMetadata
(mensagem)OperationState
(enum)Progress
(mensagem)RestoreDatabaseMetadata
(mensagem)RestoreDatabaseRequest
(mensagem)UpdateBackupScheduleRequest
(mensagem)UpdateDatabaseMetadata
(mensagem)UpdateDatabaseRequest
(mensagem)UpdateFieldRequest
(mensagem)WeeklyRecurrence
(mensagem)
FirestoreAdmin
A API Cloud Firestore Admin.
Ela oferece vários serviços administrativos para o Cloud Firestore.
Projeto, banco de dados, namespace, coleção, grupo de coleções e documento são usados conforme definido na API Google Cloud Firestore.
Operação: uma operação representa o trabalho que está sendo realizado em segundo plano.
O serviço de índice gerencia os índices do Cloud Firestore.
A criação do índice é realizada de maneira assíncrona. Um recurso de operação é criado para cada operação assíncrona. O estado da operação (incluindo todos os erros encontrados) pode ser consultado por meio do recurso "Operação".
A coleção de Operações oferece um registro das ações realizadas para o Projeto especificado (incluindo Operações em andamento). As operações não são criadas diretamente, mas por chamadas em outras coleções ou recursos.
Uma operação concluída pode ser excluída para que não seja mais listada como parte do conjunto de operações. As operações são coletadas como lixo após 30 dias. Por padrão, ListOperations só retorna operações em andamento e com falha. Para listar uma operação concluída, envie uma solicitação ListOperations com o filtro done: true
.
As operações são criadas pelo serviço FirestoreAdmin
, mas são acessadas pelo serviço google.longrunning.Operations
.
CreateBackupSchedule |
---|
Cria uma programação de backup em um banco de dados. É possível configurar no máximo duas programações de backup em um banco de dados: uma diária com retenção de até sete dias e uma semanal com retenção de até 14 semanas.
|
CreateDatabase |
---|
Cria um banco de dados.
|
CreateIndex |
---|
Cria um índice composto. Isso retorna um
|
DeleteBackup |
---|
Exclui um backup.
|
DeleteBackupSchedule |
---|
Exclui uma programação de backup.
|
DeleteDatabase |
---|
Exclui um banco de dados.
|
DeleteIndex |
---|
Exclui um índice composto.
|
ExportDocuments |
---|
Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage. As atualizações recentes nos documentos podem não aparecer na exportação. A exportação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso "Operação" criado. Só é possível usar a saída de uma exportação depois que a operação associada é concluída. Se uma operação de exportação for cancelada antes da conclusão, é possível que dados parciais sejam deixados para trás no Google Cloud Storage. Para saber mais sobre o comportamento de exportação e o formato de saída, consulte: https://cloud.google.com/firestore/docs/manage-data/export-import
|
GetBackup |
---|
Extrai informações sobre um backup.
|
GetBackupSchedule |
---|
Recebe informações sobre uma programação de backup.
|
GetDatabase |
---|
Recebe informações sobre um banco de dados.
|
GetField |
---|
Recebe os metadados e a configuração de um campo.
|
GetIndex |
---|
Recebe um índice composto.
|
ImportDocuments |
---|
Importa documentos para o Google Cloud Firestore. Os documentos existentes com o mesmo nome serão substituídos. A importação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso Operação criado. Se uma operação ImportDocuments for cancelada, talvez um subconjunto dos dados já tenha sido importado para o Cloud Firestore.
|
ListBackupSchedules |
---|
Listar programações de backup.
|
ListBackups |
---|
Lista todos os backups.
|
ListDatabases |
---|
Liste todos os bancos de dados do projeto.
|
ListFields |
---|
Lista a configuração de campo e os metadados para este banco de dados. No momento, o
|
ListIndexes |
---|
Lista índices compostos.
|
RestoreDatabase |
---|
Cria um novo banco de dados restaurando a partir de um backup atual. O novo banco de dados precisa estar na mesma região da nuvem ou no mesmo local multirregional que o backup atual. O comportamento é semelhante a [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], exceto que, em vez de criar um novo banco de dados vazio, um novo banco de dados é criado com o tipo de banco de dados, a configuração do índice e os documentos de um backup existente. O
|
UpdateBackupSchedule |
---|
Atualiza uma programação de backup.
|
UpdateDatabase |
---|
Atualiza um banco de dados.
|
UpdateField |
---|
Atualiza uma configuração de campo. No momento, as atualizações de campo se aplicam apenas à configuração de índice de campo único. No entanto, as chamadas para Essa chamada retorna um Para definir as configurações de campo padrão do banco de dados, use o
|
Backup
Backup de um banco de dados do Cloud Firestore.
O backup contém todos os documentos e configurações de índice para o banco de dados fornecido em um momento específico.
Campos | |
---|---|
name |
Apenas saída. O nome exclusivo do recurso do backup. O formato é |
database |
Apenas saída. Nome do banco de dados do Firestore de origem do backup. O formato é |
database_uid |
Apenas saída. O UUID4 gerado pelo sistema para o banco de dados do Firestore de origem do backup. |
snapshot_time |
Apenas saída. No momento, o backup contém uma cópia externamente consistente do banco de dados. |
expire_time |
Apenas saída. O carimbo de data/hora em que o backup expira. |
state |
Apenas saída. O estado atual do backup. |
Estado
Indique o estado atual do backup.
Enums | |
---|---|
STATE_UNSPECIFIED |
O estado não foi especificado. |
CREATING |
O backup pendente ainda está sendo criado. As operações no backup serão rejeitadas neste estado. |
READY |
O backup foi concluído e está pronto para uso. |
NOT_AVAILABLE |
O backup não está disponível no momento. |
BackupSchedule
Uma programação de backup para um banco de dados do Cloud Firestore.
O recurso pertence ao banco de dados do backup e é excluído com o banco de dados. Entretanto, os backups reais não são.
Campos | |
---|---|
name |
Apenas saída. O identificador exclusivo da programação de backup em todos os locais e bancos de dados de um determinado projeto. Ele será atribuído automaticamente. O formato é |
create_time |
Apenas saída. O carimbo de data/hora em que a programação de backup foi criada e entrou em vigor desde então. Nenhum backup será criado para esta programação antes desse período. |
update_time |
Apenas saída. O carimbo de data/hora em que a programação de backup foi atualizada mais recentemente. Quando uma programação de backup é criada pela primeira vez, é o mesmo que create_time. |
retention |
Em que momento relativo no futuro, em comparação com o horário de criação, o backup deve ser excluído, por exemplo, manter backups por sete dias. |
Campo de união recurrence . Um campo oneof para representar quando os backups serão feitos. recurrence pode ser apenas de um dos tipos a seguir: |
|
daily_recurrence |
Para uma programação que é executada diariamente. |
weekly_recurrence |
Para uma programação que é executada semanalmente em um dia específico. |
CreateBackupScheduleRequest
A solicitação para FirestoreAdmin.CreateBackupSchedule
.
Campos | |
---|---|
parent |
Obrigatório. O banco de dados pai. Formatar |
backup_schedule |
Obrigatório. A programação de backup a ser criada. |
CreateDatabaseMetadata
Esse tipo não tem campos.
Metadados relacionados à operação de criação do banco de dados.
CreateDatabaseRequest
A solicitação para FirestoreAdmin.CreateDatabase
.
Campos | |
---|---|
parent |
Obrigatório. Um nome pai no formato |
database |
Obrigatório. O banco de dados a ser criado. |
database_id |
Obrigatório. O ID a ser usado para o banco de dados, que se tornará o componente final do nome do recurso do banco de dados. Esse valor precisa ter de 4 a 63 caracteres. Os caracteres válidos são /[a-z][0-9]-/ com o primeiro caractere, uma letra e o último, uma letra ou um número. Não pode ser semelhante a UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. O ID do banco de dados "(padrão)" também é válido. |
CreateIndexRequest
A solicitação para FirestoreAdmin.CreateIndex
.
Campos | |
---|---|
parent |
Obrigatório. Um nome pai no formato |
index |
Obrigatório. O índice composto a ser criado. |
DailyRecurrence
Esse tipo não tem campos.
Representa uma programação recorrente que é executada em um horário específico todos os dias.
O fuso horário é UTC.
Banco de dados
Um banco de dados do Cloud Firestore.
Campos | |
---|---|
name |
O nome do recurso do banco de dados. Formato: |
uid |
Apenas saída. O UUID4 gerado pelo sistema para este banco de dados. |
create_time |
Apenas saída. O carimbo de data/hora em que este banco de dados foi criado. Os bancos de dados criados antes de 2016 não preenchem create_time. |
update_time |
Apenas saída. O carimbo de data/hora em que este banco de dados foi atualizado mais recentemente. Isso inclui apenas atualizações do recurso do banco de dados, e não dados contidos no banco de dados. |
location_id |
O local do banco de dados. Os locais disponíveis estão listados em https://cloud.google.com/firestore/docs/locations. |
type |
O tipo do banco de dados. Para saber como escolher, consulte https://cloud.google.com/datastore/docs/firestore-or-datastore. |
concurrency_mode |
O modo de controle de simultaneidade a ser usado neste banco de dados. |
version_retention_period |
Apenas saída. O período durante o qual as versões anteriores dos dados são mantidas no banco de dados. Qualquer Se o recurso PITR estiver ativado, o período de armazenamento será de sete dias. Caso contrário, o período de armazenamento será de uma hora. |
earliest_version_time |
Apenas saída. O carimbo de data/hora mais antigo em que as versões mais antigas dos dados podem ser lidas no banco de dados. Consulte [version_retention_period] acima. Esse campo é preenchido com Esse valor é atualizado continuamente e fica desatualizado no momento em que é consultado. Se você estiver usando esse valor para recuperar dados, não deixe de considerar o momento entre o momento em que o valor é consultado e o momento em que você inicia a recuperação. |
point_in_time_recovery_enablement |
Define se o recurso PITR será ativado neste banco de dados. |
app_engine_integration_mode |
O modo de integração do App Engine a ser usado para este banco de dados. |
key_prefix |
Apenas saída. O key_prefix deste banco de dados. Esse key_prefix é usado, em combinação com o ID do projeto (" Esse valor pode estar vazio. Nesse caso, o appid a ser usado para chaves codificadas com URL é o project_id (por exemplo, foo em vez de v~foo). |
delete_protection_state |
Estado da proteção contra exclusão do banco de dados. |
etag |
Essa soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de continuar. |
AppEngineIntegrationMode
O tipo de modo de integração do App Engine.
Enums | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Não utilizado. |
ENABLED |
Se houver um aplicativo do App Engine na mesma região desse banco de dados, a configuração do App Engine vai afetar esse banco de dados. Isso inclui desativar o aplicativo e o banco de dados, bem como desativar gravações no banco de dados. |
DISABLED |
O App Engine não afeta a capacidade do banco de dados de atender às solicitações. Essa é a configuração padrão para bancos de dados criados com a API Firestore. |
ConcurrencyMode
O tipo de modo de controle de simultaneidade para transações.
Enums | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
Não utilizado. |
OPTIMISTIC |
Usa o controle de simultaneidade otimista por padrão. Esse modo está disponível para bancos de dados do Cloud Firestore. |
PESSIMISTIC |
Usar o controle de simultaneidade pessimista por padrão. Esse modo está disponível para bancos de dados do Cloud Firestore. Essa é a configuração padrão do Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Use o controle de simultaneidade otimista com grupos de entidades por padrão. Esse é o único modo disponível para o Cloud Datastore. Esse modo também está disponível para o Cloud Firestore com o modo Datastore, mas não é recomendado. |
DatabaseType
O tipo do banco de dados. Para saber como escolher, consulte https://cloud.google.com/datastore/docs/firestore-or-datastore.
Mudanças de modo só são permitidas se o banco de dados estiver vazio.
Enums | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
O valor padrão. Esse valor será usado se o tipo de banco de dados for omitido. |
FIRESTORE_NATIVE |
Modo nativo do Firestore |
DATASTORE_MODE |
Firestore no modo Datastore. |
DeleteProtectionState
O estado de proteção contra exclusão do banco de dados.
Enums | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
O valor padrão. O tipo de proteção "Excluir" não foi especificado |
DELETE_PROTECTION_DISABLED |
A proteção contra exclusão está desativada |
DELETE_PROTECTION_ENABLED |
A proteção contra exclusão está ativada |
PointInTimeRecoveryEnablement
Ativação do recurso de recuperação pontual.
Enums | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
Não utilizado. |
POINT_IN_TIME_RECOVERY_ENABLED |
As leituras são aceitas em versões selecionadas dos dados dos últimos sete dias:
|
POINT_IN_TIME_RECOVERY_DISABLED |
As leituras são compatíveis com qualquer versão dos dados dentro da última hora. |
DeleteBackupRequest
A solicitação para FirestoreAdmin.DeleteBackup
.
Campos | |
---|---|
name |
Obrigatório. Nome do backup a ser excluído. formato é |
DeleteBackupScheduleRequest
A solicitação para [FirestoreAdmin.DeleteBackupSchedules][].
Campos | |
---|---|
name |
Obrigatório. O nome da programação de backup. Formatar |
DeleteDatabaseMetadata
Esse tipo não tem campos.
Metadados relacionados à operação de exclusão do banco de dados.
DeleteDatabaseRequest
A solicitação para FirestoreAdmin.DeleteDatabase
.
Campos | |
---|---|
name |
Obrigatório. Um nome no formato |
etag |
A ETag atual do banco de dados. Se uma etag for fornecida e não corresponder à atual do banco de dados, a exclusão será bloqueada e um erro FAILED_PRECONDITION será retornado. |
DeleteIndexRequest
A solicitação para FirestoreAdmin.DeleteIndex
.
Campos | |
---|---|
name |
Obrigatório. Um nome no formato |
ExportDocumentsMetadata
Metadados de google.longrunning.Operation
resultados de FirestoreAdmin.ExportDocuments
.
Campos | |
---|---|
start_time |
Hora em que a operação começou. |
end_time |
Hora em que a operação foi concluída. Não será definido se a operação ainda estiver em andamento. |
operation_state |
O estado da operação de exportação. |
progress_documents |
O progresso, em documentos, desta operação. |
progress_bytes |
O progresso, em bytes, dessa operação. |
collection_ids[] |
Os IDs de coleções que estão sendo exportados. |
output_uri_prefix |
Para onde os documentos estão sendo exportados. |
namespace_ids[] |
Quais IDs de namespace estão sendo exportados. |
snapshot_time |
O carimbo de data/hora que corresponde à versão do banco de dados que está sendo exportado. Se não for especificado, não há garantias sobre a consistência dos documentos que estão sendo exportados. |
ExportDocumentsRequest
A solicitação para FirestoreAdmin.ExportDocuments
.
Campos | |
---|---|
name |
Obrigatório. Banco de dados a ser exportado. Precisa estar no formato: |
collection_ids[] |
Quais códigos de coleção exportar. Não especificado significa todas as coleções. |
output_uri_prefix |
O URI de saída. Atualmente, só aceita URIs do Google Cloud Storage no formato: |
namespace_ids[] |
Uma lista vazia representa todos os namespaces. Esse é o uso preferencial para bancos de dados que não usam namespaces. Um elemento de string vazio representa o namespace padrão. Use se o banco de dados tiver dados em namespaces não padrão, mas você não quiser incluí-los. Cada namespace dessa lista precisa ser exclusivo. |
snapshot_time |
O carimbo de data/hora que corresponde à versão do banco de dados a ser exportado. O carimbo de data/hora precisa estar no passado, arredondado para os minutos e não pode ser anterior a |
ExportDocumentsResponse
Retornado no campo de resposta google.longrunning.Operation
.
Campos | |
---|---|
output_uri_prefix |
Localização dos arquivos de saída. Isso poderá ser usado para iniciar uma importação no Cloud Firestore (este ou outro projeto) após a conclusão da operação. |
Campo
Representa um único campo no banco de dados.
Os campos são agrupados pelo "Grupo de coleções", que representa todos os conjuntos no banco de dados com o mesmo ID.
Campos | |
---|---|
name |
Obrigatório. Um nome de campo no formato Ele pode ser um nome de campo simples, como Os caminhos do campo podem ser citados usando Exemplos: (Observação: os comentários aqui estão escritos em sintaxe markdown, portanto há uma camada adicional de crases para representar um bloco de código) Uma |
index_config |
A configuração de índice para este campo. Se não for definida, a indexação de campo vai reverter para a configuração definida pelo |
ttl_config |
A configuração de TTL deste |
IndexConfig
A configuração de índice para este campo.
Campos | |
---|---|
indexes[] |
Os índices compatíveis com este campo. |
uses_ancestor_config |
Apenas saída. Quando verdadeiro, a configuração de índice de |
ancestor_field |
Apenas saída. Especifica o nome do recurso da |
reverting |
Saída apenas quando verdadeiro, a configuração de índice de |
TtlConfig
A configuração de TTL (vida útil) para documentos que tenham esse Field
definido.
O armazenamento de um valor de carimbo de data/hora em um campo ativado para TTL será tratado como o prazo de validade absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento está qualificado para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desativa a expiração do documento individual.
Campos | |
---|---|
state |
Apenas saída. O estado da configuração do TTL. |
Estado
O estado de aplicação da configuração de TTL a todos os documentos.
Enums | |
---|---|
STATE_UNSPECIFIED |
O estado não foi especificado ou é desconhecido. |
CREATING |
O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Os documentos recém-gravados terão a TTL aplicada conforme solicitado. Os TTLs solicitados nos documentos existentes ainda estão sendo processados. Quando os TTLs em todos os documentos existentes forem processados, o estado passará para "ACTIVE". |
ACTIVE |
O TTL está ativo para todos os documentos. |
NEEDS_REPAIR |
Não foi possível ativar a configuração de TTL para todos os documentos existentes. O TTL dos documentos recém-gravados continuará sendo aplicado. A LRO retornada na última tentativa de ativar o TTL para este Field falhou e pode ter mais detalhes. |
FieldOperationMetadata
Metadados de google.longrunning.Operation
resultados de FirestoreAdmin.UpdateField
.
Campos | |
---|---|
start_time |
Hora em que a operação começou. |
end_time |
Hora em que a operação foi concluída. Não será definido se a operação ainda estiver em andamento. |
field |
O recurso de campo em que a operação está agindo. Exemplo: |
index_config_deltas[] |
Uma lista de |
state |
Estado da operação. |
progress_documents |
O progresso, em documentos, desta operação. |
progress_bytes |
O progresso, em bytes, dessa operação. |
ttl_config_delta |
Descreve os deltas da configuração de TTL. |
IndexConfigDelta
Informações sobre uma alteração na configuração de índice.
Campos | |
---|---|
change_type |
Especifica como o índice está sendo alterado. |
index |
O índice que está sendo alterado. |
ChangeType
Especifica como o índice está sendo alterado.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
O tipo de alteração não foi especificado ou não é conhecido. |
ADD |
O índice de campo único está sendo adicionado. |
REMOVE |
O índice de campo único está sendo removido. |
TtlConfigDelta
Informações sobre uma alteração na configuração de TTL.
Campos | |
---|---|
change_type |
Especifica como a configuração do TTL está mudando. |
ChangeType
Especifica como a configuração de TTL está mudando.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
O tipo de alteração não foi especificado ou não é conhecido. |
ADD |
A configuração de TTL está sendo adicionada. |
REMOVE |
A configuração de TTL está sendo removida. |
GetBackupRequest
A solicitação para FirestoreAdmin.GetBackup
.
Campos | |
---|---|
name |
Obrigatório. Nome do backup a ser buscado. O formato é |
GetBackupScheduleRequest
A solicitação para FirestoreAdmin.GetBackupSchedule
.
Campos | |
---|---|
name |
Obrigatório. O nome da programação de backup. Formatar |
GetDatabaseRequest
A solicitação para FirestoreAdmin.GetDatabase
.
Campos | |
---|---|
name |
Obrigatório. Um nome no formato |
GetFieldRequest
A solicitação para FirestoreAdmin.GetField
.
Campos | |
---|---|
name |
Obrigatório. Um nome no formato |
GetIndexRequest
A solicitação para FirestoreAdmin.GetIndex
.
Campos | |
---|---|
name |
Obrigatório. Um nome no formato |
ImportDocumentsMetadata
Metadados de google.longrunning.Operation
resultados de FirestoreAdmin.ImportDocuments
.
Campos | |
---|---|
start_time |
Hora em que a operação começou. |
end_time |
Hora em que a operação foi concluída. Não será definido se a operação ainda estiver em andamento. |
operation_state |
O estado da operação de importação. |
progress_documents |
O progresso, em documentos, desta operação. |
progress_bytes |
O progresso, em bytes, dessa operação. |
collection_ids[] |
Os códigos de coleção que estão sendo importados. |
input_uri_prefix |
O local dos documentos que estão sendo importados. |
namespace_ids[] |
Quais IDs de namespace estão sendo importados. |
ImportDocumentsRequest
A solicitação para FirestoreAdmin.ImportDocuments
.
Campos | |
---|---|
name |
Obrigatório. Banco de dados no qual importar. Precisa estar no formato: |
collection_ids[] |
IDs de coleções a serem importados. "Não especificado" significa que todas as coleções incluídas na importação. |
input_uri_prefix |
Local dos arquivos exportados. Precisa corresponder ao output_uri_prefix de um ExportDocumentsResponse de uma exportação concluída. Consulte: |
namespace_ids[] |
Uma lista vazia representa todos os namespaces. Esse é o uso preferencial para bancos de dados que não usam namespaces. Um elemento de string vazio representa o namespace padrão. Use se o banco de dados tiver dados em namespaces não padrão, mas você não quiser incluí-los. Cada namespace dessa lista precisa ser exclusivo. |
Índice
Os índices do Cloud Firestore permitem consultas simples e complexas em documentos em um banco de dados.
Campos | |
---|---|
name |
Apenas saída. Um nome definido pelo servidor para esse índice. O formato desse nome para índices compostos será: |
query_scope |
Os índices com um escopo de consulta de coleção especificado permitem consultas em uma coleção que é filha de um documento específico, especificada no momento da consulta e que tem o mesmo ID de coleção. Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todos os conjuntos descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que este índice. |
api_scope |
O escopo da API com suporte nesse índice. |
fields[] |
Os campos aceitos por esse índice. Para índices compostos, isso requer no mínimo dois e no máximo 100 campos. A última entrada de campo é sempre para o caminho do campo Para índices de campo único, será sempre exatamente uma entrada com um caminho de campo igual ao caminho do campo associado. |
state |
Apenas saída. O estado de exibição do índice. |
ApiScope
O escopo da API define as APIs (nativas do Firestore ou Firestore no modo Datastore) que são compatíveis com as consultas.
Enums | |
---|---|
ANY_API |
O índice só pode ser usado pela API de consulta nativa do Firestore. Esse é o padrão. |
DATASTORE_MODE_API |
O índice só pode ser usado pelo Firestore na API de consulta do modo Datastore. |
IndexField
Um campo em um índice. O campo field_path descreve qual campo está indexado, o value_mode descreve como o valor do campo é indexado.
Campos | |
---|---|
field_path |
Pode ser name. Para índices de campo único, ele precisa corresponder ao nome do campo ou pode ser omitido. |
Campo de união value_mode . Como o valor do campo é indexado. value_mode pode ser apenas de um dos tipos a seguir: |
|
order |
Indica que este campo oferece suporte para ordenação pela ordem especificada ou comparação usando =, !=, <, <=, >, >=. |
array_config |
Indica que este campo é compatível com operações em |
ArrayConfig
As configurações de valor de matriz compatíveis.
Enums | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
O índice não oferece suporte a outras consultas de matriz. |
CONTAINS |
O índice é compatível com consultas de contenção de matrizes. |
Pedido
As ordens com suporte.
Enums | |
---|---|
ORDER_UNSPECIFIED |
A ordem não foi especificada. Não é uma opção válida. |
ASCENDING |
O campo é ordenado pelo valor do campo crescente. |
DESCENDING |
O campo é ordenado por valor de campo decrescente. |
QueryScope
"Escopo da consulta" define o escopo em que uma consulta é executada. Isso é especificado em um campo from
de StructuredQuery.
Enums | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
O escopo da consulta não foi especificado. Não é uma opção válida. |
COLLECTION |
Os índices com um escopo de consulta de coleção especificado permitem consultas em uma coleção que é filha de um documento específico, especificada no momento da consulta e que tem o ID de coleção especificado pelo índice. |
COLLECTION_GROUP |
Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todos os conjuntos que têm o ID da coleção especificado pelo índice. |
COLLECTION_RECURSIVE |
Inclua todos os ancestrais das coleções no índice. Disponível apenas para bancos de dados do modo Datastore. |
Estado
O estado de um índice. Durante a criação, um índice estará no estado CREATING
. Se o índice for criado, ele vai fazer a transição para o estado READY
. Se houver um problema na criação do índice, ele fará a transição para o estado NEEDS_REPAIR
.
Enums | |
---|---|
STATE_UNSPECIFIED |
O estado não foi especificado. |
CREATING |
O índice está sendo criado. Há uma operação ativa de longa duração para o índice. O índice é atualizado durante a gravação de um documento. Pode haver alguns dados de índice. |
READY |
O índice está pronto para ser usado. O índice é atualizado durante a gravação de um documento. O índice é totalmente preenchido com todos os documentos armazenados aos quais ele se aplica. |
NEEDS_REPAIR |
O índice estava sendo criado, mas algo deu errado. Não há uma operação de longa duração ativa para o índice, e a operação de longa duração concluída mais recentemente falhou. O índice não é atualizado durante a gravação de um documento. Pode haver alguns dados de índice. Use a API google.longrunning.Operations para determinar o motivo da falha da última tentativa de criar esse índice e, em seguida, recrie o índice. |
IndexOperationMetadata
Metadados de google.longrunning.Operation
resultados de FirestoreAdmin.CreateIndex
.
Campos | |
---|---|
start_time |
Hora em que a operação começou. |
end_time |
Hora em que a operação foi concluída. Não será definido se a operação ainda estiver em andamento. |
index |
O recurso de índice em que esta operação está atuando. Exemplo: |
state |
Estado da operação. |
progress_documents |
O progresso, em documentos, desta operação. |
progress_bytes |
O progresso, em bytes, dessa operação. |
ListBackupSchedulesRequest
A solicitação para FirestoreAdmin.ListBackupSchedules
.
Campos | |
---|---|
parent |
Obrigatório. O banco de dados pai. O formato é |
ListBackupSchedulesResponse
A resposta para FirestoreAdmin.ListBackupSchedules
.
Campos | |
---|---|
backup_schedules[] |
Lista de todas as programações de backup. |
ListBackupsRequest
A solicitação para FirestoreAdmin.ListBackups
.
Campos | |
---|---|
parent |
Obrigatório. O local do qual os backups serão listados. O formato é |
ListBackupsResponse
A resposta para FirestoreAdmin.ListBackups
.
Campos | |
---|---|
backups[] |
Lista de todos os backups do projeto. |
unreachable[] |
Lista de locais em que não foi possível buscar os backups atuais. Em vez de falhar todas as solicitações quando um único local está inacessível, essa resposta retorna um conjunto de resultados parciais e uma lista de locais que não podem ser alcançados aqui. A solicitação pode ser repetida em um único local para receber um erro concreto. |
ListDatabasesRequest
Uma solicitação para listar os bancos de dados do Firestore em todos os locais de um projeto.
Campos | |
---|---|
parent |
Obrigatório. Um nome pai no formato |
ListDatabasesResponse
A lista de bancos de dados de um projeto.
Campos | |
---|---|
databases[] |
Os bancos de dados no projeto. |
unreachable[] |
Caso os dados sobre bancos de dados individuais não possam ser listados, eles serão registrados aqui. Um exemplo de entrada pode ser: projects/some_project/locations/some_location. Isso pode acontecer se a região do Cloud em que o banco de dados reside estiver indisponível no momento. Nesse caso, não foi possível buscar todos os detalhes do banco de dados. Você pode receber uma mensagem de erro mais detalhada (ou possivelmente buscar o recurso) enviando uma solicitação "Get" para o recurso ou uma solicitação "List" para o local específico. |
ListFieldsRequest
A solicitação para FirestoreAdmin.ListFields
.
Campos | |
---|---|
parent |
Obrigatório. Um nome pai no formato |
filter |
O filtro que será aplicado aos resultados da lista. No momento, o |
page_size |
O número de resultados a serem retornados. |
page_token |
Um token de página, retornado de uma chamada anterior para |
ListFieldsResponse
A resposta para FirestoreAdmin.ListFields
.
Campos | |
---|---|
fields[] |
Os campos solicitados. |
next_page_token |
Um token de página que pode ser usado para solicitar outra página de resultados. Se o campo ficar em branco, essa será a última página. |
ListIndexesRequest
A solicitação para FirestoreAdmin.ListIndexes
.
Campos | |
---|---|
parent |
Obrigatório. Um nome pai no formato |
filter |
O filtro que será aplicado aos resultados da lista. |
page_size |
O número de resultados a serem retornados. |
page_token |
Um token de página, retornado de uma chamada anterior para |
ListIndexesResponse
A resposta para FirestoreAdmin.ListIndexes
.
Campos | |
---|---|
indexes[] |
Os índices solicitados. |
next_page_token |
Um token de página que pode ser usado para solicitar outra página de resultados. Se o campo ficar em branco, essa será a última página. |
LocationMetadata
Esse tipo não tem campos.
A mensagem de metadados para google.cloud.location.Location.metadata
.
OperationState
Descreve o estado da operação.
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Não especificado. |
INITIALIZING |
A solicitação está sendo preparada para processamento. |
PROCESSING |
A solicitação está sendo processada ativamente. |
CANCELLING |
A solicitação está em processo de cancelamento após o usuário chamar google.longrunning.Operations.CancelOperation na operação. |
FINALIZING |
A solicitação foi processada e está na etapa de finalização. |
SUCCESSFUL |
A solicitação foi concluída. |
FAILED |
A solicitação foi processada, mas encontrou um erro. |
CANCELLED |
O cancelamento da solicitação foi concluído após o usuário chamar google.longrunning.Operations.CancelOperation. |
Progresso
Descreve o progresso da operação. A unidade de trabalho é genérica e precisa ser interpretada com base no local onde o Progress
é usado.
Campos | |
---|---|
estimated_work |
A quantidade de trabalho estimada. |
completed_work |
A quantidade de trabalho concluído. |
RestoreDatabaseMetadata
Metadados do long-running operation
da solicitação [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Campos | |
---|---|
start_time |
A hora em que a restauração foi iniciada. |
end_time |
O horário em que a restauração foi concluída, não configurado para restaurações em andamento. |
operation_state |
O estado de operação da restauração. |
database |
O nome do banco de dados que está sendo restaurado. |
backup |
O nome do backup que restaura. |
progress_percentage |
O tempo de conclusão da restauração como uma porcentagem estimada do tempo restante. |
RestoreDatabaseRequest
A mensagem de solicitação para [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Campos | |
---|---|
parent |
Obrigatório. O projeto em que o banco de dados será restaurado. O formato é |
database_id |
Obrigatório. O ID a ser usado para o banco de dados, que se tornará o componente final do nome do recurso do banco de dados. Este ID de banco de dados não pode estar associado a um banco de dados existente. Esse valor precisa ter de 4 a 63 caracteres. Os caracteres válidos são /[a-z][0-9]-/ com o primeiro caractere, uma letra e o último, uma letra ou um número. Não pode ser semelhante a UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. O ID do banco de dados "(padrão)" também é válido. |
Campo de união
|
|
backup |
Backup a ser restaurado. Precisa ser do mesmo projeto que o pai. O formato é: |
UpdateBackupScheduleRequest
A solicitação para FirestoreAdmin.UpdateBackupSchedule
.
Campos | |
---|---|
backup_schedule |
Obrigatório. A programação de backup a ser atualizada. |
update_mask |
Lista de campos a serem atualizados. |
UpdateDatabaseMetadata
Esse tipo não tem campos.
Metadados relacionados à operação de atualização do banco de dados.
UpdateDatabaseRequest
A solicitação para FirestoreAdmin.UpdateDatabase
.
Campos | |
---|---|
database |
Obrigatório. O banco de dados a ser atualizado. |
update_mask |
Lista de campos a serem atualizados. |
UpdateFieldRequest
A solicitação para FirestoreAdmin.UpdateField
.
Campos | |
---|---|
field |
Obrigatório. O campo a ser atualizado. |
update_mask |
Uma máscara relativa ao campo. Se especificado, somente a configuração especificada por essa field_mask será atualizada no campo. |
WeeklyRecurrence
Representa uma programação recorrente executada em um dia especificado da semana.
O fuso horário é UTC.
Campos | |
---|---|
day |
O dia da semana a ser executado. DAY_OF_WEEK_UNSPECIFIED não é permitido. |