Package google.firestore.admin.v1

string

Apenas saída. O nome de recurso exclusivo do backup.

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

string

Apenas saída. Nome do banco de dados do Firestore de origem do backup.

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

string

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

Timestamp

Apenas saída. No momento, o backup contém uma cópia externa consistente do banco de dados.

Timestamp

Apenas saída. O carimbo de data/hora em que o backup expira.

State

Apenas saída. O estado atual do backup.

string

Apenas saída. O identificador exclusivo da programação 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}

Timestamp

Apenas saída. O carimbo de data/hora em que a programação de backup foi criada e está em vigor desde então.

Nenhum backup será criado para esta programação antes desse período.

Timestamp

Apenas saída. O carimbo de data/hora em que essa programação de backup foi atualizada mais recentemente. Quando uma programação de backup é criada pela primeira vez, é o mesmo que create_time.

Duration

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

O período de armazenamento máximo permitido é de 14 semanas.

DailyRecurrence

Para uma programação que é executada diariamente.

WeeklyRecurrence

Para uma programação executada semanalmente em um dia específico.

string

Obrigatório. O banco de dados pai.

Formato projects/{project}/databases/{database}

BackupSchedule

Obrigatório. A programação de backup a ser criada.

string

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

Database

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

string

Obrigatório. O ID a ser usado no 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}/.

"(padrão)" do banco de dados também é válido.

string

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

Index

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

string

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

string

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

Timestamp

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

Timestamp

Apenas saída. O carimbo de data/hora em que esse banco de dados foi atualizado pela última vez. Observe que isso inclui apenas atualizações do recurso do banco de dados e não dos dados contidos nele.

Timestamp

Apenas saída. O carimbo de data/hora em que o banco de dados foi excluído. Defina apenas se o banco de dados tiver sido excluído.

string

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

DatabaseType

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

ConcurrencyMode

O modo de controle de simultaneidade a ser usado neste banco de dados.

Duration

Apenas saída. O período em que as versões anteriores dos dados são retidas no banco de dados.

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

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.

Timestamp

Apenas saída. O carimbo de data/hora mais antigo em que versões mais antigas dos dados podem ser lidas do 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, 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.

PointInTimeRecoveryEnablement

Define se o recurso PITR deve ser ativado neste banco de dados.

AppEngineIntegrationMode

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

string

Apenas saída. O key_prefix para este banco de dados. Esse key_prefix é usado com o ID do projeto ("~") para criar o ID do aplicativo retornado das APIs do Cloud Datastore nos ambientes de execução de primeira geração do Google App Engine.

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

DeleteProtectionState

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

CmekConfig

Opcional. "Presença" indica que a CMEK está ativada para este banco de dados.

string

Apenas saída. O ID do banco de dados anterior do recurso de banco de dados. Este campo só é preenchido para bancos de dados excluídos.

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.

string

Obrigatório. Somente as chaves no mesmo local desse banco de dados podem ser usadas para criptografia.

Para a multirregião nam5 do Firestore, isso corresponde à multirregião us do Cloud KMS. Para a multirregião eur3 do Firestore, isso corresponde à Europa multirregional do Cloud KMS. Consulte https://cloud.google.com/kms/docs/locations.

O formato esperado é projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string

Apenas saída. Versões de chaves KMS em uso. Durante a rotação de chaves, pode haver várias versões de chaves em uso.

O formato esperado é projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

string

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

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

string

Obrigatório. O nome da programação de backup.

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

string

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

string

A etag atual do banco de dados. Se uma ETag for fornecida e não corresponder à ETag atual do banco de dados, a exclusão será bloqueada e um erro FAILED_PRECONDITION será retornado.

string

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

Timestamp

Hora em que a operação foi iniciada.

Timestamp

A hora em que essa operação foi concluída. Não será definido se a operação ainda estiver em andamento.

OperationState

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

Progress

O progresso, em documentos, dessa operação.

Progress

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

string

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

string

Para onde os documentos estão sendo exportados.

string

Quais IDs de namespace estão sendo exportados.

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 haverá garantias de consistência dos documentos que estão sendo exportados.

string

Obrigatório. Banco de dados a ser exportado. Precisa estar no formato: projects/{project_id}/databases/{database_id}.

string

Os IDs de coleções a serem exportados. "Não especificado" significa todas as coleções. Cada ID de coleção nessa lista precisa ser exclusivo.

string

O URI de saída. No momento, só oferece suporte a URIs do Google Cloud Storage no formato: gs://BUCKET_NAME[/NAMESPACE_PATH], em que BUCKET_NAME é o nome do bucket do Google Cloud Storage e NAMESPACE_PATH é um caminho de namespace opcional 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 no horário de início.

string

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. Isso deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nessa lista precisa ser exclusivo.

Timestamp

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, no máximo, earliestVersionTime. Se especificado, os documentos exportados representam uma visualização consistente do banco de dados no momento fornecido. Caso contrário, não há garantias de consistência dos documentos exportados.

string

Localização dos arquivos de saída. Isso pode ser usado para iniciar uma importação para o Cloud Firestore (este ou outro projeto) depois que a operação for concluída com êxito.

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 em map_value, por exemplo, address.city ou um caminho de campo especial. O único campo especial válido é *, que representa qualquer campo.

Os caminhos de campo 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),[,]`, além de caracteres simbólicos ASCII.

Exemplos: os comentários aqui são escritos na sintaxe de markdown, portanto há uma camada adicional de crases para representar um bloco de código. \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, nenhum 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 tiverem sua própria configuração de índice Field.

IndexConfig

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

TtlConfig

A configuração de TTL deste Field. Definir ou cancelar a configuração vai ativar ou desativar o TTL para documentos que tenham esse Field.

Index

Os índices compatíveis com este campo.

bool

Apenas saída. Quando verdadeiro, a configuração de índice de Field é definida com base na configuração especificada por ancestor_field. Quando falso, a configuração de índice de Field é definida explicitamente.

string

Apenas saída. Especifica o nome do recurso do Field em que a configuração de índice desse campo é definida (quando uses_ancestor_config é verdadeiro) ou do qual seria definida se o campo não tivesse configuração de índice (quando uses_ancestor_config é falso).

bool

Somente saída. Quando verdadeiro, a configuração do índice de Field está em processo de reversão. Após a conclusão, a configuração do índice vai passar para o mesmo estado do campo especificado por ancestor_field. A partir de então, uses_ancestor_config será true, e reverting será false.

State

Apenas saída. O estado da configuração do TTL.

Timestamp

Hora em que a operação foi iniciada.

Timestamp

A hora em que essa operação foi concluída. Não será definido se a operação ainda estiver em andamento.

string

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

IndexConfigDelta

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

OperationState

O estado da operação.

Progress

O progresso, em documentos, dessa operação.

Progress

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

TtlConfigDelta

Descreve os deltas da configuração de TTL.

ChangeType

Especifica como o índice está mudando.

Index

O índice que está sendo alterado.

ChangeType

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

string

Obrigatório. Nome do backup a ser buscado.

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

string

Obrigatório. O nome da programação de backup.

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

string

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

string

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

string

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

Timestamp

Hora em que a operação foi iniciada.

Timestamp

A hora em que essa operação foi concluída. Não será definido se a operação ainda estiver em andamento.

OperationState

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

Progress

O progresso, em documentos, dessa operação.

Progress

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

string

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

string

O local dos documentos que estão sendo importados.

string

Quais IDs de namespace estão sendo importados.

string

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

string

Os IDs de coleções a serem importados. Não especificado significa que todas as coleções incluídas na importação.

string

Local dos arquivos exportados. Ele precisa corresponder ao output_uri_prefix de um ExportDocumentsResponse de uma exportação concluída. Consulte: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string

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. Isso deve ser usado se o banco de dados tiver dados em namespaces não padrão, mas não quiser incluí-los. Cada namespace nessa lista precisa ser exclusivo.

string

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

QueryScope

Os índices com um escopo de consulta de coleção especificado permitem fazer 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 todas as coleções descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que o índice.

ApiScope

O escopo da API suportado por este índice.

IndexField

Os campos suportados por este índice.

Para índices compostos, isso requer no mínimo 2 e no máximo 100 campos. A última entrada de campo é sempre para o caminho do campo __name__. Se, na criação, __name__ não tiver sido especificado como o ú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 ASCENDING (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

Apenas saída. O estado de exibição do índice.

string

Pode ser name. Para índices de campo único, ele precisa corresponder ao nome do campo ou pode ser omitido.

Order

Indica que este campo é compatível com a ordenação pela ordem especificada ou comparação usando =, !=, <, <=, >, >=.

ArrayConfig

Indica que o campo é compatível com operações em array_values.

VectorConfig

Indica que este campo aceita operações de vizinho e distância mais próximas no vetor.

int32

Obrigatório. A dimensão vetorial à qual essa configuração se aplica.

O índice resultante incluirá apenas vetores dessa dimensão e poderá ser usado para pesquisa de vetor com a mesma dimensão.

FlatIndex

Indica que o índice vetorial é plano.

Timestamp

Hora em que a operação foi iniciada.

Timestamp

A hora em que essa operação foi concluída. Não será definido se a operação ainda estiver em andamento.

string

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

OperationState

O estado da operação.

Progress

O progresso, em documentos, dessa operação.

Progress

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

string

Obrigatório. O banco de dados pai.

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

BackupSchedule

Lista de todas as programações de backup.

string

Obrigatório. O local de onde os backups serão listados.

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

Backup

Lista de todos os backups do projeto.

string

Lista de locais em que não foi possível buscar os backups atuais.

Em vez de falhar em todas as solicitações quando um único local está inacessível, essa resposta retorna um conjunto de resultados parcial e uma lista de locais que não podem ser acessados aqui. A solicitação pode ser repetida em um único local para gerar um erro concreto.

string

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

bool

Se verdadeiro, também retorna recursos excluídos.

Database

Os bancos de dados no projeto.

string

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 não estiver disponível no momento. Nesse caso, não é possível buscar todos os detalhes sobre o banco de dados. Você pode receber uma mensagem de erro mais detalhada (ou possivelmente buscar o recurso) enviando um comando "Get" solicitação para o recurso ou uma "List" para o local específico.

string

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

string

O filtro a ser aplicado aos resultados da lista. No momento, FirestoreAdmin.ListFields só é compatível com a listagem de campos que foram explicitamente modificados. Para emitir essa consulta, chame FirestoreAdmin.ListFields com um filtro que inclua indexConfig.usesAncestorConfig:false ou ttlConfig:*.

int32

O número de resultados a serem retornados.

string

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

Field

Os campos solicitados.

string

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

string

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

string

O filtro a ser aplicado aos resultados da lista.

int32

O número de resultados a serem retornados.

string

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

Index

Os índices solicitados.

string

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

int64

A quantidade de trabalho estimada.

int64

A quantidade de trabalho concluída.

Timestamp

A hora em que a restauração foi iniciada.

Timestamp

O horário em que a restauração foi concluída, não definido para restaurações em andamento.

OperationState

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

string

O nome do banco de dados que está sendo restaurado.

string

O nome da restauração do backup.

Progress

O período da restauração como uma porcentagem estimada do tempo restante.

string

Obrigatório. O projeto em que o banco de dados será restaurado. O formato é projects/{project_id}.

string

Obrigatório. O ID a ser usado no banco de dados, que se tornará o componente final do nome do recurso do banco de dados. Esse 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}/.

"(padrão)" do banco de dados também é válido.

string

Backup a ser restaurado. Precisa ser do mesmo projeto que o pai.

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

BackupSchedule

Obrigatório. A programação de backup a ser atualizada.

FieldMask

Lista de campos a serem atualizados.

Database

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

FieldMask

Lista de campos a serem atualizados.

Field

Obrigatório. O campo a ser atualizado.

FieldMask

Uma máscara relativa ao campo. Se especificado, somente a configuração especificada por esta field_mask será atualizada no campo.

DayOfWeek

O dia da semana a ser executado.

DAY_OF_WEEK_UNSPECIFIED não é permitido.