Package google.firestore.admin.v1beta1

Índice

FirestoreAdmin

A API de administração do Cloud Firestore.

Esta API fornece vários serviços administrativos para Cloud Firestore.

Conceitos

Projeto, banco de dados, namespace, coleção 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.

Serviços

Índice

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.

Metadados

Fornece metadados e informações estatísticas sobre dados no Cloud Firestore. Os dados fornecidos como parte desta API podem estar desatualizados.

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 que ainda não foi realizada poderá ser cancelada. A solicitação de cancelamento é assíncrona e a Operação pode continuar em execução por algum tempo após a solicitação de cancelamento ser feita.

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 criadas pelo serviço FirestoreAdmin , mas são acessadas por meio do serviço google.longrunning.Operations .

CriarIndex

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

Cria o índice especificado. O estado inicial de um índice recém-criado é CREATING . Após a conclusão do google.longrunning.Operation retornado, o estado será READY . Se o índice já existir, a chamada retornará um status ALREADY_EXISTS .

Durante a criação, o processo pode resultar em erro e, nesse caso, o índice passará para o estado ERROR . O processo pode ser recuperado corrigindo os dados que causaram o erro, removendo o índice com delete e recriando o índice com create .

Índices com um único campo não podem ser criados.

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.

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 .

ObterIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

Obtém um índice.

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 .

Índices de lista

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

Lista os índices que correspondem aos filtros especificados.

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

O nome do banco de dados ao qual este índice será aplicado. Por exemplo: projects/{project_id}/databases/{database_id}

index

Index

O índice a ser criado. Os campos nome e estado são apenas gerados e serão ignorados. Certos índices de campo único não podem ser criados ou excluídos.

ExcluirIndexRequest

A solicitação para FirestoreAdmin.DeleteIndex .

Campos
name

string

O nome do índice. Por exemplo: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportarDocumentosMetadados

Metadados para operações ExportDocuments.

Campos
start_time

Timestamp

A hora em que o trabalho começou na operação.

end_time

Timestamp

A hora em que a operação terminou, com êxito ou não. Desativar se a operação ainda estiver ativa.

operation_state

OperationState

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

progress_documents

Progress

Uma estimativa do número de documentos processados.

progress_bytes

Progress

Uma estimativa do número de bytes processados.

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 conclusão da operação com êxito.

ObterIndexRequest

A solicitação para FirestoreAdmin.GetIndex .

Campos
name

string

O nome do índice. Por exemplo: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportarDocumentosMetadados

Metadados para operações ImportDocuments.

Campos
start_time

Timestamp

A hora em que o trabalho começou na operação.

end_time

Timestamp

A hora em que a operação terminou, com êxito ou não. Desativar se a operação ainda estiver ativa.

operation_state

OperationState

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

progress_documents

Progress

Uma estimativa do número de documentos processados.

progress_bytes

Progress

Uma estimativa do número de bytes processados.

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

Índice

Uma definição de índice.

Campos
name

string

O nome do recurso do índice. Apenas saída.

collection_id

string

O ID da coleção à qual esse índice se aplica. Obrigatório.

fields[]

IndexField

Os campos a serem indexados.

state

State

O estado do índice. Somente saída.

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 o índice não puder ser criado, ele passará para o estado ERROR .

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

CampoIndex

Um campo de um índice.

Campos
field_path

string

O caminho do campo. Deve corresponder à especificação do caminho do campo descrita por [google.firestore.v1beta1.Document.fields][fields]. O campo especial path __name__ pode ser usado sozinho ou no final de um caminho. __type__ pode ser usado apenas no final do caminho.

mode

Mode

O modo do campo.

Modo

O modo determina como um campo é indexado.

Enums
MODE_UNSPECIFIED O modo não é especificado.
ASCENDING Os valores do campo são indexados de forma a suportar o sequenciamento em ordem crescente e também a consulta por <, >, <=, >= e =.
DESCENDING Os valores do campo são indexados de forma a suportar o sequenciamento em ordem decrescente e também a consulta por <, >, <=, >= e =.
ARRAY_CONTAINS Os valores da matriz do campo são indexados para suportar a associação usando consultas ARRAY_CONTAINS.

IndexOperationMetadados

Metadados para operações de índice. Esses metadados preenchem o campo de metadados de google.longrunning.Operation .

Campos
start_time

Timestamp

A hora em que o trabalho começou na operação.

end_time

Timestamp

A hora em que a operação terminou, com êxito ou não. Desativar se a operação ainda estiver ativa.

index

string

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

operation_type

OperationType

O tipo de operação de índice.

cancelled

bool

Verdadeiro se google.longrunning.Operation tiver sido cancelado. Se o cancelamento estiver em andamento, cancelled será verdadeiro, mas google.longrunning.Operation.done será falso.

document_progress

Progress

Progresso da operação existente, medido em número de documentos.

Tipo de operação

O tipo de operação de índice.

Enums
OPERATION_TYPE_UNSPECIFIED Não especificado. Nunca definido pelo servidor.
CREATING_INDEX A operação está criando o índice. Iniciado por uma chamada CreateIndex .

ListaIndexesRequest

A solicitação para FirestoreAdmin.ListIndexes .

Campos
parent

string

O nome do banco de dados. Por exemplo: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

O tamanho padrão da página da lista.

page_token

string

O token padrão da página Lista.

ListIndexesResposta

A resposta para FirestoreAdmin.ListIndexes .

Campos
indexes[]

Index

Os índices.

next_page_token

string

O token padrão da próxima página da lista.

LocalizaçãoMetadados

Este tipo não possui campos.

A mensagem de metadados para google.cloud.location.Location.metadata .

Estado de Operação

Os vários estados possíveis para uma Operação em andamento.

Enums
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

Mede o progresso de uma métrica específica.

Campos
work_completed

int64

Uma estimativa de quanto trabalho foi concluído. Observe que isso pode ser maior que work_estimated .

work_estimated

int64

Uma estimativa de quanto trabalho precisa ser executado. Zero se a estimativa de trabalho não estiver disponível. Pode mudar conforme o trabalho avança.