Package google.firestore.admin.v1

Índice

FirestoreAdmin

A API de administração do Cloud Firestore.

Esta API fornece vários serviços administrativos para 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 sendo executado em segundo plano.

O serviço de índice gerencia índices do Cloud Firestore.

A criação do índice é realizada de forma assíncrona. Um recurso de Operação é criado para cada operação assíncrona. O estado da operação (incluindo quaisquer erros encontrados) pode ser consultado através do recurso Operação.

A coleção Operações fornece um registro das ações executadas para o Projeto especificado (incluindo quaisquer Operações em andamento). As operações não são criadas diretamente, mas através de chamadas a outras coleções ou recursos.

Uma Operação realizada pode ser excluída para que não seja mais listada como parte da coleção de Operações. As operações são coletadas como lixo após 30 dias. Por padrão, ListOperations retornará apenas operações em andamento e com falha. Para listar a operação concluída, emita uma solicitação ListOperations com o filtro done: true .

As operações são criadas pelo serviço FirestoreAdmin , mas são acessadas por meio do serviço google.longrunning.Operations .

CriarBackupSchedule

rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )

Cria um agendamento de backup em um banco de dados. No máximo dois agendamentos de backup podem ser configurados em um banco de dados, um agendamento de backup diário com retenção de até 7 dias e um agendamento de backup semanal com retenção de até 14 semanas.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Criar banco de dados

rpc CreateDatabase( CreateDatabaseRequest ) returns ( Operation )

Crie um banco de dados.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

CriarIndex

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

Cria um índice composto. Isso retorna um google.longrunning.Operation que pode ser usado para rastrear o status da criação. Os metadados da operação serão do tipo IndexOperationMetadata .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Excluir backup

rpc DeleteBackup( DeleteBackupRequest ) returns ( Empty )

Exclui um backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ExcluirBackupSchedule

rpc DeleteBackupSchedule( DeleteBackupScheduleRequest ) returns ( Empty )

Exclui um agendamento de backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Excluir banco de dados

rpc DeleteDatabase( DeleteDatabaseRequest ) returns ( Operation )

Exclui um banco de dados.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ExcluirIndex

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

Exclui um índice composto.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Exportar documentos

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Exporta uma cópia de todos ou de um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage. As atualizações recentes dos documentos podem não ser refletidas na exportação. A exportação ocorre em segundo plano e seu andamento pode ser monitorado e gerenciado por meio do recurso Operação criado. A saída de uma exportação só pode ser usada depois que a operação associada for concluída. Se uma operação de exportação for cancelada antes da conclusão, poderá deixar dados parciais no Google Cloud Storage.

Para obter mais detalhes sobre o comportamento de exportação e formato de saída, consulte: https://cloud.google.com/firestore/docs/manage-data/export-import

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Obter backup

rpc GetBackup( GetBackupRequest ) returns ( Backup )

Obtém informações sobre um backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ObterBackupSchedule

rpc GetBackupSchedule( GetBackupScheduleRequest ) returns ( BackupSchedule )

Obtém informações sobre um agendamento de backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Obter banco de dados

rpc GetDatabase( GetDatabaseRequest ) returns ( Database )

Obtém informações sobre um banco de dados.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ObterCampo

rpc GetField( GetFieldRequest ) returns ( Field )

Obtém os metadados e a configuração de um campo.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ObterIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

Obtém um índice composto.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Importar Documentos

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Importa documentos para o Google Cloud Firestore. Os documentos existentes com o mesmo nome são substituídos. A importação ocorre em segundo plano e seu andamento pode ser monitorado e gerenciado por meio do recurso Operação criado. Se uma operação ImportDocuments for cancelada, é possível que um subconjunto de dados já tenha sido importado para o Cloud Firestore.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ListBackupSchedules

rpc ListBackupSchedules( ListBackupSchedulesRequest ) returns ( ListBackupSchedulesResponse )

Liste programações de backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ListaBackups

rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )

Lista todos os backups.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Listabancos de dados

rpc ListDatabases( ListDatabasesRequest ) returns ( ListDatabasesResponse )

Liste todos os bancos de dados do projeto.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ListFields

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

Lista a configuração de campo e os metadados deste banco de dados.

Atualmente, FirestoreAdmin.ListFields oferece suporte apenas à listagem de campos que foram explicitamente substituídos. Para emitir esta consulta, chame FirestoreAdmin.ListFields com o filtro definido como indexConfig.usesAncestorConfig:false ou ttlConfig:* .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Índices de lista

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

Lista índices compostos.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Restaurar banco de dados

rpc RestoreDatabase( RestoreDatabaseRequest ) returns ( Operation )

Cria um novo banco de dados restaurando a partir de um backup existente.

O novo banco de dados deve estar na mesma região de nuvem ou local multirregional que o backup existente. Isso se comporta de maneira 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, configuração de índice e documentos de um backup existente.

A long-running operation pode ser usada para rastrear o progresso da restauração, com o tipo de campo metadata da Operação sendo RestoreDatabaseMetadata . O tipo response será o Database se a restauração tiver sido bem-sucedida. O novo banco de dados não poderá ser lido ou gravado até que a LRO seja concluída.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

AtualizarBackupSchedule

rpc UpdateBackupSchedule( UpdateBackupScheduleRequest ) returns ( BackupSchedule )

Atualiza um agendamento de backup.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Atualizar o banco de dados

rpc UpdateDatabase( UpdateDatabaseRequest ) returns ( Operation )

Atualiza um banco de dados.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Campo de atualização

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

Atualiza uma configuração de campo. Atualmente, as atualizações de campo aplicam-se apenas à configuração de índice de campo único. No entanto, as chamadas para FirestoreAdmin.UpdateField devem fornecer uma máscara de campo para evitar a alteração de qualquer configuração da qual o chamador não tenha conhecimento. A máscara do campo deve ser especificada como: { paths: "index_config" } .

Esta chamada retorna um google.longrunning.Operation que pode ser usado para rastrear o status da atualização do campo. Os metadados da operação serão do tipo FieldOperationMetadata .

Para definir as configurações de campo padrão para o banco de dados, use o Field especial com nome de recurso: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

Cópia de segurança

Um backup de um banco de dados Cloud Firestore.

O backup contém todos os documentos e configurações de índice do banco de dados específico em um momento específico.

Campos
name

string

Somente saída. O nome exclusivo do recurso do Backup.

O formato é projects/{project}/locations/{location}/backups/{backup} .

database

string

Somente saída. Nome do banco de dados do Firestore de onde vem o backup.

O formato é projects/{project}/databases/{database} .

database_uid

string

Somente saída. O UUID4 gerado pelo sistema para o banco de dados do Firestore de onde vem o backup.

snapshot_time

Timestamp

Somente saída. O backup contém uma cópia externamente consistente do banco de dados neste momento.

expire_time

Timestamp

Somente saída. O carimbo de data/hora em que esse backup expira.

state

State

Somente saída. O estado atual do backup.

Estado

Indique o estado atual do backup.

Enums
STATE_UNSPECIFIED O estado não é especificado.
CREATING O backup pendente ainda está sendo criado. As operações no backup serão rejeitadas neste estado.
READY O backup está completo e pronto para uso.
NOT_AVAILABLE O backup não está disponível neste momento.

Agendamento de backup

Uma programação de backup para um banco de dados Cloud Firestore.

Este recurso pertence ao banco de dados do qual está sendo feito backup e é excluído junto com o banco de dados. Os backups reais não são.

Campos
name

string

Somente saída. O identificador exclusivo de agendamento de backup em todos os locais e bancos de dados de um determinado projeto.

Isso será atribuído automaticamente.

O formato é projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

create_time

Timestamp

Somente saída. O carimbo de data/hora em que esse agendamento de backup foi criado e em vigor desde então.

Nenhum backup será criado para esta programação antes desse horário.

update_time

Timestamp

Somente saída. O carimbo de data/hora em que esse agendamento de backup foi atualizado mais recentemente. Quando um agendamento de backup é criado pela primeira vez, é igual a create_time.

retention

Duration

Em que momento relativo no futuro, comparado ao horário de criação, o backup deverá ser excluído, por exemplo, manter os backups por 7 dias.

recurrence do campo de união. Um campo oneof para representar quando os backups serão feitos. recurrence pode ser apenas uma das seguintes:
daily_recurrence

DailyRecurrence

Para uma programação executada diariamente em um horário especificado.

weekly_recurrence

WeeklyRecurrence

Para uma programação executada semanalmente em um dia e horário específicos.

CriarBackupScheduleRequest

A solicitação para FirestoreAdmin.CreateBackupSchedule .

Campos
parent

string

Obrigatório. O banco de dados pai.

Formatar projects/{project}/databases/{database}

backup_schedule

BackupSchedule

Obrigatório. O agendamento de backup a ser criado.

CriarDatabaseMetadata

Este tipo não possui campos.

Metadados relacionados à operação de criação de banco de dados.

CriarDatabaseRequest

A solicitação para FirestoreAdmin.CreateDatabase .

Campos
parent

string

Obrigatório. Um nome pai do formulário projects/{project_id}

database

Database

Obrigatório. O banco de dados a ser criado.

database_id

string

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 valor deve ter de 4 a 63 caracteres. Os caracteres válidos são /[az][0-9]-/ sendo o primeiro caractere uma letra e o último uma letra ou um número. Não deve ser do tipo 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.

CriarIndexRequest

A solicitação para FirestoreAdmin.CreateIndex .

Campos
parent

string

Obrigatório. Um nome pai do formulário projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

Obrigatório. O índice composto a ser criado.

Recorrência Diária

Este tipo não possui campos.

Representa uma programação recorrente executada em um horário específico todos os dias.

O fuso horário é UTC.

Base de dados

Um banco de dados Cloud Firestore.

Campos
name

string

O nome do recurso do banco de dados. Formato: projects/{project}/databases/{database}

uid

string

Somente saída. O UUID4 gerado pelo sistema para este banco de dados.

create_time

Timestamp

Somente saída. O carimbo de data/hora em que esse banco de dados foi criado. Os bancos de dados criados antes de 2016 não preenchem create_time.

update_time

Timestamp

Somente saída. O carimbo de data/hora em que esse banco de dados foi atualizado mais recentemente. Observe que isso inclui apenas atualizações no recurso de banco de dados e não dados contidos no banco de dados.

location_id

string

A localização do banco de dados. Os locais disponíveis estão listados em https://cloud.google.com/firestore/docs/locations .

type

DatabaseType

O tipo do banco de dados. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obter informações sobre como escolher.

concurrency_mode

ConcurrencyMode

O modo de controle de simultaneidade a ser usado para esse banco de dados.

version_retention_period

Duration

Somente saída. O período durante o qual as versões anteriores dos dados são retidas no banco de dados.

Qualquer read ou query pode especificar um read_time nesta janela e lerá o estado do banco de dados naquele momento.

Se o recurso PITR estiver habilitado, o período de retenção será de 7 dias. Caso contrário, o período de retenção é de 1 hora.

earliest_version_time

Timestamp

Somente saída. O carimbo de data/hora mais antigo em que versões mais antigas dos dados podem ser lidas no banco de dados. Consulte [version_retention_period] acima; este campo é preenchido com now - version_retention_period .

Esse valor é atualizado continuamente e fica obsoleto no momento em que é consultado. Se você estiver usando esse valor para recuperar dados, leve em consideração o tempo desde o momento em que o valor é consultado até o momento em que você inicia a recuperação.

point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Se o recurso PITR deve ser habilitado neste banco de dados.

app_engine_integration_mode

AppEngineIntegrationMode

O modo de integração do App Engine a ser usado para esse banco de dados.

key_prefix

string

Somente saída. O key_prefix deste banco de dados. Este key_prefix é usado, em combinação com o id do projeto (" ~ ") para construir o ID do aplicativo retornado pelas APIs do Cloud Datastore nos ambientes de execução de primeira geração do Google App Engine.

Este valor pode estar vazio, caso em que o appid a ser usado para chaves codificadas em URL é o project_id (por exemplo: foo em vez de v~foo).

delete_protection_state

DeleteProtectionState

Estado de proteção contra exclusão do banco de dados.

etag

string

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

Modo de integração do AppEngine

O tipo de modo de integração do App Engine.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Não usado.
ENABLED Se existir um aplicativo do App Engine na mesma região deste banco de dados, a configuração do App Engine afetará esse banco de dados. Isso inclui a desativação do aplicativo e do banco de dados, bem como a desativação de gravações no banco de dados.
DISABLED

O App Engine não afeta a capacidade desse banco de dados de atender solicitações.

Esta é a configuração padrão para bancos de dados criados com a API Firestore.

Modo de simultaneidade

O tipo de modo de controle de simultaneidade para transações.

Enums
CONCURRENCY_MODE_UNSPECIFIED Não usado.
OPTIMISTIC Use o controle de simultaneidade otimista por padrão. Este modo está disponível para bancos de dados Cloud Firestore.
PESSIMISTIC

Use o controle de simultaneidade pessimista por padrão. Este modo está disponível para bancos de dados Cloud Firestore.

Esta é 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.

Este é o único modo disponível para o Cloud Datastore.

Este modo também está disponível para Cloud Firestore com modo Datastore, mas não é recomendado.

Tipo de banco de dados

O tipo do banco de dados. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obter informações sobre como escolher.

Mudanças de modo só serão permitidas se o banco de dados estiver vazio.

Enums
DATABASE_TYPE_UNSPECIFIED O valor padrão. Este valor será usado se o tipo de banco de dados for omitido.
FIRESTORE_NATIVE Modo nativo do Firestore
DATASTORE_MODE Firestore no modo Datastore.

ExcluirProtectionState

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 contra exclusão 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 usado.
POINT_IN_TIME_RECOVERY_ENABLED

As leituras são suportadas em versões selecionadas dos dados dos últimos 7 dias:

  • Lê qualquer carimbo de data/hora na última hora
  • Lê instantâneos de 1 minuto além de 1 hora e dentro de 7 dias

version_retention_period e earliest_version_time podem ser usados ​​para determinar as versões suportadas.

POINT_IN_TIME_RECOVERY_DISABLED As leituras são suportadas em qualquer versão dos dados da última 1 hora.

ExcluirBackupRequest

A solicitação para FirestoreAdmin.DeleteBackup .

Campos
name

string

Obrigatório. Nome do backup a ser excluído.

o formato é projects/{project}/locations/{location}/backups/{backup} .

ExcluirBackupScheduleRequest

A solicitação para [FirestoreAdmin.DeleteBackupSchedules][].

Campos
name

string

Obrigatório. O nome do agendamento de backup.

Formatar projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

ExcluirDatabaseMetadata

Este tipo não possui campos.

Metadados relacionados à operação de exclusão do banco de dados.

ExcluirDatabaseRequest

A solicitação para FirestoreAdmin.DeleteDatabase .

Campos
name

string

Obrigatório. Um nome no formato projects/{project_id}/databases/{database_id}

etag

string

O etag atual do banco de dados. Se um etag for fornecido e não corresponder ao etag atual do banco de dados, a exclusão será bloqueada e um erro FAILED_PRECONDITION será retornado.

ExcluirIndexRequest

A solicitação para FirestoreAdmin.DeleteIndex .

Campos
name

string

Obrigatório. Um nome no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportarDocumentosMetadados

Metadados para resultados de google.longrunning.Operation de FirestoreAdmin.ExportDocuments .

Campos
start_time

Timestamp

A hora em que esta operação foi iniciada.

end_time

Timestamp

A hora em que esta operação foi concluída. Será desativado se a operação ainda estiver em andamento.

operation_state

OperationState

O estado da operação de exportação.

progress_documents

Progress

O andamento, em documentos, desta operação.

progress_bytes

Progress

O progresso, em bytes, desta operação.

collection_ids[]

string

Quais IDs de coleção estão sendo exportados.

output_uri_prefix

string

Para onde os documentos estão sendo exportados.

namespace_ids[]

string

Quais IDs de namespace estão sendo exportados.

snapshot_time

Timestamp

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

Solicitação de Exportação de Documentos

A solicitação para FirestoreAdmin.ExportDocuments .

Campos
name

string

Obrigatório. Banco de dados para exportar. Deve estar no formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Quais IDs de coleção exportar. Não especificado significa todas as coleções.

output_uri_prefix

string

O URI de saída. Atualmente, só é compatível com URIs do Google Cloud Storage no formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , em que BUCKET_NAME é o nome do intervalo do Google Cloud Storage e NAMESPACE_PATH é um caminho opcional do namespace do Google Cloud Storage. Ao escolher um nome, considere as diretrizes de nomenclatura do Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Se o URI for um bucket (sem caminho de namespace), um prefixo será gerado com base na hora de início.

namespace_ids[]

string

Uma lista vazia representa todos os namespaces. Este é o uso preferencial para bancos de dados que não usam namespaces.

Um elemento de string vazio representa o namespace padrão. Deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nesta lista deve ser exclusivo.

snapshot_time

Timestamp

O carimbo de data/hora que corresponde à versão do banco de dados a ser exportado. O carimbo de data/hora deve estar no passado, arredondado para o minuto e não ser anterior a earliestVersionTime . Se especificado, os documentos exportados representarão uma visão consistente do banco de dados no momento fornecido. Caso contrário, não há garantias sobre a consistência dos documentos exportados.

ExportDocumentsResponse

Retornado no campo de resposta google.longrunning.Operation .

Campos
output_uri_prefix

string

Localização dos arquivos de saída. Isso pode ser usado para iniciar uma importação para o Cloud Firestore (este projeto ou outro projeto) após a operação ser concluída com sucesso.

Campo

Representa um único campo no banco de dados.

Os campos são agrupados pelo seu “Grupo de Coleções”, que representa todas as coleções do banco de dados com o mesmo id.

Campos
name

string

Obrigatório. Um nome de campo do formulário projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Um caminho de campo pode ser um nome de campo simples, por exemplo, address ou um caminho para campos dentro de map_value , por exemplo, address.city , ou um caminho de campo especial. O único campo especial válido é * , que representa qualquer campo.

Os caminhos dos campos podem ser citados usando (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), [ , ]`, bem como quaisquer caracteres simbólicos ascii.

Exemplos: (Observação: os comentários aqui são escritos em sintaxe de marcação, portanto, há uma camada adicional de crases para representar um bloco de código) \ address.city` represents a field named address.city , not the map key city in the field address . `*` represents a field named *`, não qualquer campo.

Um Field especial contém as configurações de indexação padrão para todos os campos. O nome do recurso deste campo é: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Os índices definidos neste Field serão aplicados a todos os campos que não possuem sua própria configuração de índice Field .

index_config

IndexConfig

A configuração do índice para este campo. Se não for definido, a indexação do campo reverterá para a configuração definida pelo ancestor_field . Para remover explicitamente todos os índices deste campo, especifique uma configuração de índice com uma lista vazia de índices.

ttl_config

TtlConfig

A configuração TTL para este Field . Definir ou desmarcar isso ativará ou desativará o TTL para documentos que possuem este Field .

IndexConfig

A configuração do índice para este campo.

Campos
indexes[]

Index

Os índices suportados para este campo.

uses_ancestor_config

bool

Somente saída. Quando verdadeiro, a configuração do índice do Field é definida a partir da configuração especificada pelo ancestor_field . Quando falso, a configuração do índice do Field é definida explicitamente.

ancestor_field

string

Somente saída. Especifica o nome do recurso do Field a partir do qual a configuração de índice deste campo é definida (quando uses_ancestor_config for verdadeiro) ou a partir do qual seria definido se este campo não tivesse configuração de índice (quando uses_ancestor_config fosse falso).

reverting

bool

Somente saída Quando verdadeiro, a configuração do índice do Field está em processo de reversão. Depois de concluído, a configuração do índice fará a transição para o mesmo estado do campo especificado por ancestor_field , ponto em que uses_ancestor_config será true e reverting será false .

TtlConfig

A configuração TTL (time-to-live) para documentos que possuem esse Field definido.

Armazenar um valor de carimbo de data/hora em um campo habilitado para TTL será tratado como o tempo de expiração absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento é elegível para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desabilitará a expiração do documento individual.

Campos
state

State

Somente saída. O estado da configuração TTL.

Estado

O estado de aplicação da configuração TTL a todos os documentos.

Enums
STATE_UNSPECIFIED O estado não é especificado ou é desconhecido.
CREATING O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Documentos recém-escritos terão TTLs aplicados conforme solicitado. Os TTLs solicitados em documentos existentes ainda estão sendo processados. Quando os TTLs de todos os documentos existentes forem processados, o estado passará para 'ATIVO'.
ACTIVE O TTL está ativo para todos os documentos.
NEEDS_REPAIR A configuração TTL não pôde ser habilitada para todos os documentos existentes. Documentos recém-escritos continuarão a ter seu TTL aplicado. A LRO retornada na última tentativa de habilitar o TTL para este Field falhou e pode ter mais detalhes.

FieldOperationMetadados

Metadados para resultados de google.longrunning.Operation de FirestoreAdmin.UpdateField .

Campos
start_time

Timestamp

A hora em que esta operação foi iniciada.

end_time

Timestamp

A hora em que esta operação foi concluída. Será desativado se a operação ainda estiver em andamento.

field

string

O recurso de campo no qual esta operação está atuando. Por exemplo: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

Uma lista de IndexConfigDelta , que descreve a intenção desta operação.

state

OperationState

O estado da operação.

progress_documents

Progress

O andamento, em documentos, desta operação.

progress_bytes

Progress

O progresso, em bytes, desta operação.

ttl_config_delta

TtlConfigDelta

Descreve os deltas da configuração TTL.

IndexConfigDelta

Informações sobre uma alteração na configuração do índice.

Campos
change_type

ChangeType

Especifica como o índice está mudando.

index

Index

O índice sendo alterado.

AlterarTipo

Especifica como o índice está mudando.

Enums
CHANGE_TYPE_UNSPECIFIED O tipo de alteração não é especificado ou 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 do TTL.

Campos
change_type

ChangeType

Especifica como a configuração do TTL está mudando.

AlterarTipo

Especifica como a configuração do TTL está mudando.

Enums
CHANGE_TYPE_UNSPECIFIED O tipo de alteração não é especificado ou conhecido.
ADD A configuração TTL está sendo adicionada.
REMOVE A configuração TTL está sendo removida.

ObterBackupRequest

A solicitação para FirestoreAdmin.GetBackup .

Campos
name

string

Obrigatório. Nome do backup a ser buscado.

O formato é projects/{project}/locations/{location}/backups/{backup} .

GetBackupScheduleRequest

A solicitação para FirestoreAdmin.GetBackupSchedule .

Campos
name

string

Obrigatório. O nome do agendamento de backup.

Formatar projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

ObterDatabaseRequest

A solicitação para FirestoreAdmin.GetDatabase .

Campos
name

string

Obrigatório. Um nome no formato projects/{project_id}/databases/{database_id}

ObterFieldRequest

A solicitação para FirestoreAdmin.GetField .

Campos
name

string

Obrigatório. Um nome do formulário projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

ObterIndexRequest

A solicitação para FirestoreAdmin.GetIndex .

Campos
name

string

Obrigatório. Um nome no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportarDocumentosMetadados

Metadados para resultados de google.longrunning.Operation de FirestoreAdmin.ImportDocuments .

Campos
start_time

Timestamp

A hora em que esta operação foi iniciada.

end_time

Timestamp

A hora em que esta operação foi concluída. Será desativado se a operação ainda estiver em andamento.

operation_state

OperationState

O estado da operação de importação.

progress_documents

Progress

O andamento, em documentos, desta operação.

progress_bytes

Progress

O progresso, em bytes, desta operação.

collection_ids[]

string

Quais IDs de coleção estão sendo importados.

input_uri_prefix

string

A localização dos documentos que estão sendo importados.

namespace_ids[]

string

Quais IDs de namespace estão sendo importados.

Solicitação de importação de documentos

A solicitação para FirestoreAdmin.ImportDocuments .

Campos
name

string

Obrigatório. Banco de dados para importar. Deve estar no formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Quais IDs de coleção importar. Não especificado significa todas as coleções incluídas na importação.

input_uri_prefix

string

Localização dos arquivos exportados. Deve corresponder ao output_uri_prefix de um ExportDocumentsResponse de uma exportação que foi concluída com êxito. Consulte: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix .

namespace_ids[]

string

Uma lista vazia representa todos os namespaces. Este é o uso preferencial para bancos de dados que não usam namespaces.

Um elemento de string vazio representa o namespace padrão. Deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nesta lista deve ser exclusivo.

Índice

Os índices do Cloud Firestore permitem consultas simples e complexas em documentos em um banco de dados.

Campos
name

string

Somente saída. Um nome definido pelo servidor para este índice. A forma deste nome para índices compostos será: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Para índices de campo único, este campo estará vazio.

query_scope

QueryScope

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 possui o mesmo ID de coleção.

Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todas as coleções descendentes de um documento específico, especificado no momento da consulta, e que possuem o mesmo ID de coleção que esse índice.

api_scope

ApiScope

O escopo da API compatível com este índice.

fields[]

IndexField

Os campos suportados por este índice.

Para índices compostos, isso requer um mínimo de 2 e um máximo de 100 campos. A última entrada do campo é sempre para o caminho do campo __name__ . Se, na criação, __name__ não foi especificado como último campo, ele será adicionado automaticamente com a mesma direção do último campo definido. Se o campo final em um índice composto não for direcional, o __name__ será ordenado ASCENDENTE (a menos que especificado explicitamente).

Para índices de campo único, será sempre exatamente uma entrada com um caminho de campo igual ao caminho do campo associado.

state

State

Somente saída. O estado de veiculação do índice.

ApiScope

O escopo da API define as APIs (Firestore Native ou Firestore no modo Datastore) compatíveis com consultas.

Enums
ANY_API O índice só pode ser usado pela API de consulta nativa do Firestore. Este é o padrão.
DATASTORE_MODE_API O índice só pode ser usado pela API de consulta do Firestore no modo Datastore.

CampoIndex

Um campo em um índice. O field_path descreve qual campo é indexado, o value_mode descreve como o valor do campo é indexado.

Campos
field_path

string

Pode ser nome . Para índices de campo único, deve 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 um dos seguintes:
order

Order

Indica que este campo suporta ordenação pela ordem especificada ou comparação usando =, !=, <, <=, >, >=.

array_config

ArrayConfig

Indica que este campo oferece suporte a operações em array_value s.

ArrayConfig

As configurações de valores de matriz suportadas.

Enums
ARRAY_CONFIG_UNSPECIFIED O índice não oferece suporte a consultas adicionais de array.
CONTAINS O índice oferece suporte a consultas de contenção de array.

Ordem

Os pedidos suportados.

Enums
ORDER_UNSPECIFIED A ordem não é especificada. Não é uma opção válida.
ASCENDING O campo é ordenado por valor de campo crescente.
DESCENDING O campo é ordenado por valor de campo decrescente.

QueryScope

Query Scope define o escopo no qual uma consulta é executada. Isso é especificado no campo from de um StructuredQuery.

Enums
QUERY_SCOPE_UNSPECIFIED O escopo da consulta não é 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 é filho de um documento específico, especificado no momento da consulta e que tem o ID da coleção especificado pelo índice.
COLLECTION_GROUP Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todas as coleções que possuem o ID de coleção especificado pelo índice.
COLLECTION_RECURSIVE Incluir 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 do índice, um índice estará no estado CREATING . Se o índice for criado com sucesso, ele fará a transição para o estado READY . Se a criação do índice encontrar um problema, o índice fará a transição para o estado NEEDS_REPAIR .

Enums
STATE_UNSPECIFIED O estado não é especificado.
CREATING O índice está sendo criado. Há uma operação ativa de longa duração para o índice. O índice é atualizado ao escrever um documento. Alguns dados de índice podem existir.
READY O índice está pronto para ser usado. O índice é atualizado ao escrever um documento. O índice é totalmente preenchido com todos os documentos armazenados aos quais se aplica.
NEEDS_REPAIR O índice estava sendo criado, mas algo deu errado. Não há nenhuma operação ativa de longa duração para o índice e a operação de longa execução concluída mais recentemente falhou. O índice não é atualizado ao escrever um documento. Alguns dados de índice podem existir. Use a API google.longrunning.Operations para determinar por que a última operação que tentou criar esse índice falhou e, em seguida, recrie o índice.

IndexOperationMetadados

Metadados para resultados de google.longrunning.Operation de FirestoreAdmin.CreateIndex .

Campos
start_time

Timestamp

A hora em que esta operação foi iniciada.

end_time

Timestamp

A hora em que esta operação foi concluída. Será desativado se a operação ainda estiver em andamento.

index

string

O recurso de índice no qual esta operação está atuando. Por exemplo: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

state

OperationState

O estado da operação.

progress_documents

Progress

O andamento, em documentos, desta operação.

progress_bytes

Progress

O progresso, em bytes, desta operação.

ListBackupSchedulesRequest

A solicitação para FirestoreAdmin.ListBackupSchedules .

Campos
parent

string

Obrigatório. O banco de dados pai.

O formato é projects/{project}/databases/{database} .

ListBackupSchedulesResponse

A resposta para FirestoreAdmin.ListBackupSchedules .

Campos
backup_schedules[]

BackupSchedule

Lista de todos os agendamentos de backup.

ListaBackupsRequest

A solicitação para FirestoreAdmin.ListBackups .

Campos
parent

string

Obrigatório. O local de onde listar os backups.

O formato é projects/{project}/locations/{location} . Use {location} = '-' para listar backups de todos os locais de um determinado projeto. Isso permite listar backups de um único local ou de todos os locais.

ListaBackupsResposta

A resposta para FirestoreAdmin.ListBackups .

Campos
backups[]

Backup

Lista de todos os backups do projeto.

unreachable[]

string

Lista de locais onde os backups existentes não puderam ser obtidos.

Em vez de falhar em todas as solicitações quando um único local está inacessível, esta 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 obter um erro concreto.

ListaDatabasesRequest

Uma solicitação para listar os bancos de dados do Firestore em todos os locais de um projeto.

Campos
parent

string

Obrigatório. Um nome pai do formulário projects/{project_id}

ListaDatabasesResponse

A lista de bancos de dados de um projeto.

Campos
databases[]

Database

Os bancos de dados no projeto.

unreachable[]

string

Caso os dados sobre bases de dados individuais não possam ser listados, eles serão registrados aqui.

Um exemplo de entrada pode ser: projetos/algum_projeto/locais/algum_local Isso pode acontecer se a região da nuvem em que o banco de dados reside estiver indisponível no momento. Neste caso não podemos buscar todos os detalhes do banco de dados. Você pode obter 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.

ListaFieldsRequest

A solicitação para FirestoreAdmin.ListFields .

Campos
parent

string

Obrigatório. Um nome pai do formulário projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

O filtro a ser aplicado aos resultados da lista. Atualmente, FirestoreAdmin.ListFields oferece suporte apenas à listagem de campos que foram explicitamente substituídos. Para emitir esta consulta, chame FirestoreAdmin.ListFields com um filtro que inclua indexConfig.usesAncestorConfig:false .

page_size

int32

O número de resultados a serem retornados.

page_token

string

Um token de página, devolvido de uma chamada anterior para FirestoreAdmin.ListFields , que pode ser usado para obter a próxima página de resultados.

ListfieldsResponse

A resposta para FirestoreAdmin.ListFields .

Campos
fields[]

Field

Os campos solicitados.

next_page_token

string

Um token de página que pode ser usado para solicitar outra página de resultados. Se em branco, esta é a última página.

ListIndexesRequest

O pedido de FirestoreAdmin.ListIndexes .

Campos
parent

string

Obrigatório. Um nome pai dos projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

O filtro a ser aplicado aos resultados da lista.

page_size

int32

O número de resultados para retornar.

page_token

string

Um token de página, devolvido de uma chamada anterior para FirestoreAdmin.ListIndexes , que pode ser usado para obter a próxima página de resultados.

ListIndexesResponse

A resposta para FirestoreAdmin.ListIndexes .

Campos
indexes[]

Index

Os índices solicitados.

next_page_token

string

Um token de página que pode ser usado para solicitar outra página de resultados. Se em branco, esta é a última página.

LocationMetadata

Este 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 o processamento.
PROCESSING A solicitação está sendo processada ativamente.
CANCELLING A solicitação está em processo de cancelamento depois que o usuário chamado google.longRunning.operations.Canceloperation na operação.
FINALIZING A solicitação foi processada e está em seu estágio de finalização.
SUCCESSFUL A solicitação foi concluída com sucesso.
FAILED A solicitação terminou de ser processada, mas encontrou um erro.
CANCELLED A solicitação terminou de ser cancelada depois que o usuário chamado google.longRunning.operations.canceloperation.

Progresso

Descreve o progresso da operação. A unidade de trabalho é genérica e deve ser interpretada com base em onde Progress é usado.

Campos
estimated_work

int64

A quantidade de trabalho estimado.

completed_work

int64

A quantidade de trabalho concluído.

RestauradoTabaseMetadata

Metadados para a long-running operation do [restauredatabase] [google.firestore.admin.v1.restoredatabase] solicitação.

Campos
start_time

Timestamp

O tempo em que a restauração foi iniciada.

end_time

Timestamp

O tempo em que a restauração terminou, não atendida para restaurações em andamento.

operation_state

OperationState

O estado de operação da restauração.

database

string

O nome do banco de dados está sendo restaurado.

backup

string

O nome do backup restaurando.

progress_percentage

Progress

Qual a distância ao longo da restauração como uma porcentagem estimada do tempo restante.

Restauredatabaserequest

A mensagem de solicitação para [firestoreadmin.restoredatabase] [google.firestore.admin.v1.restoredatabase].

Campos
parent

string

Obrigatório. O projeto para restaurar o banco de dados em. Formato é projects/{project_id} .

database_id

string

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 ID do banco de dados não deve estar associado a um banco de dados existente.

Este valor deve ser de 4-63 caracteres. Os caracteres válidos são / [AZ] [0-9]- / com o primeiro caractere de uma carta e a última carta ou um número. Não deve ser Uuid-Like /[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.

source do campo da união.

source pode ser apenas um dos seguintes:

backup

string

Backup para restaurar. Deve ser do mesmo projeto que o pai.

O formato é: projects/{project_id}/locations/{location}/backups/{backup}

UpdateBackupScheduleReQuest

A solicitação de FirestoreAdmin.UpdateBackupSchedule .

Campos
backup_schedule

BackupSchedule

Obrigatório. O cronograma de backup para atualizar.

update_mask

FieldMask

A lista de campos a serem atualizados.

UpdatedAtABASEMETADATA

Este tipo não tem campos.

Metadados relacionados à operação de banco de dados de atualização.

UpdatedAtAbaseReQuest

A solicitação de FirestoreAdmin.UpdateDatabase .

Campos
database

Database

Obrigatório. O banco de dados a ser atualizado.

update_mask

FieldMask

A lista de campos a serem atualizados.

UpdateFieldRequest

O pedido de FirestoreAdmin.UpdateField .

Campos
field

Field

Obrigatório. O campo a ser atualizado.

update_mask

FieldMask

Uma máscara, em relação ao campo. Se especificado, apenas a configuração especificada por este Field_mask será atualizada no campo.

Recorrência Semanal

Representa um cronograma recorrente que é executado em um dia especificado da semana.

O fuso horário é UTC.

Campos
day

DayOfWeek

O dia da semana para correr.

Day_Of_Week_UnSpecificado não é permitido.