Package google.firestore.admin.v1beta2

Índice

FirestoreAdmin

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

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 .

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.

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 .

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 .

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 .

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 .

CriarIndexRequest

A solicitação para FirestoreAdmin.CreateIndex .

Campos
parent

string

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

index

Index

O índice composto a ser criado.

ExcluirIndexRequest

A solicitação para FirestoreAdmin.DeleteIndex .

Campos
name

string

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 as entidades estão sendo exportadas.

Solicitação de Exportação de Documentos

A solicitação para FirestoreAdmin.ExportDocuments .

Campos
name

string

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.

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

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.

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

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

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.

document_progress

Progress

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

bytes_progress

Progress

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

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.

ObterFieldRequest

A solicitação para FirestoreAdmin.GetField .

Campos
name

string

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

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.

Solicitação de importação de documentos

A solicitação para FirestoreAdmin.ImportDocuments .

Campos
name

string

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.v1beta2.ExportDocumentsResponse.output_uri_prefix .

Índice

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

Campos
name

string

Apenas 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 é filho de um documento específico, especificado 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.

fields[]

IndexField

Os campos suportados por este índice.

Para índices compostos, são sempre 2 ou mais 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

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

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 é filha de um documento específico, especificada 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.

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.

ListaFieldsRequest

A solicitação para FirestoreAdmin.ListFields .

Campos
parent

string

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 o filtro definido como indexConfig.usesAncestorConfig:false .

page_size

int32

O número de resultados a serem retornados.

page_token

string

Um token de página, retornado 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 estiver em branco, esta é a última página.

ListaIndexesRequest

A solicitação para FirestoreAdmin.ListIndexes .

Campos
parent

string

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.

page_size

int32

O número de resultados a serem retornados.

page_token

string

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

ListIndexesResposta

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 estiver em branco, esta é a última página.

Estado de Operação

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 depois que o usuário chamou google.longrunning.Operations.CancelOperation na operação.
FINALIZING A solicitação foi processada e está em fase 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 foi cancelada depois que o usuário chamou 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 estimada.

completed_work

int64

A quantidade de trabalho concluído.

Solicitação de campo de atualização

A solicitação para FirestoreAdmin.UpdateField .

Campos
field

Field

O campo a ser atualizado.

update_mask

FieldMask

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