Package google.firestore.admin.v1beta1

Índice

FirestoreAdmin

A API Cloud Firestore Admin.

Ela oferece vários serviços administrativos para o 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 que está sendo realizado em segundo plano.

Serviços

Índice

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

A criação do índice é realizada de maneira assíncrona. Um recurso de operação é criado para cada operação assíncrona. O estado da operação (incluindo todos os erros encontrados) pode ser consultado por meio do recurso "Operação".

Metadados

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

Operação

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

Uma operação que ainda não foi concluída pode ser cancelada. A solicitação de cancelamento é assíncrona e a operação pode continuar a ser executada por algum tempo após a realização da solicitação de cancelamento.

Uma operação concluída pode ser excluída para que não seja mais listada como parte do conjunto de operações.

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Cria o índice especificado. O estado inicial de um índice recém-criado é CREATING. Quando o google.longrunning.Operation retornado for concluído, 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 um erro. Nesse caso, o índice será movido para o estado ERROR. Para recuperar o processo, corrija os dados que causaram o erro, removendo o índice com delete e recriando o índice com create.

Não é possível criar índices com um único campo.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Exclui um índice.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Exporta uma cópia de todos ou um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage. As atualizações recentes nos documentos podem não aparecer na exportação. A exportação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso "Operação" criado. Só é possível usar a saída de uma exportação depois que a operação associada é concluída. Se uma operação de exportação for cancelada antes da conclusão, é possível que dados parciais sejam deixados para trás no Google Cloud Storage.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Recebe um índice.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importa documentos para o Google Cloud Firestore. Os documentos existentes com o mesmo nome serão substituídos. A importação ocorre em segundo plano, e o progresso dela pode ser monitorado e gerenciado pelo recurso Operação criado. Se uma operação ImportDocuments for cancelada, talvez um subconjunto dos dados já tenha sido importado para o Cloud Firestore.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Lista os índices que correspondem aos filtros especificados.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

CreateIndexRequest

A solicitação para FirestoreAdmin.CreateIndex.

Campos
parent

string

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

Index

O índice a ser criado. Os campos de nome e estado são apenas uma saída e serão ignorados. Não é possível criar ou excluir determinados índices de campo único.

DeleteIndexRequest

A solicitação para FirestoreAdmin.DeleteIndex.

Campos
name

string

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

ExportDocumentsMetadata

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 sucesso ou não. Não definido 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

Os IDs de coleções que estão sendo exportados.
output_uri_prefix

string

Para onde as entidades são exportadas.

ExportDocumentsRequest

A solicitação para FirestoreAdmin.ExportDocuments.

Campos
name

string

Banco de dados a ser exportado. Precisa estar no formato: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Quais códigos de coleção exportar. Não especificado significa todas as coleções.
output_uri_prefix

string

O URI de saída. Atualmente, só aceita 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 um caminho de namespace, um prefixo será gerado com base no horário 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 poderá ser usado para iniciar uma importação no Cloud Firestore (este ou outro projeto) após a conclusão da operação.

GetIndexRequest

A solicitação para FirestoreAdmin.GetIndex.

Campos
name

string

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

ImportDocumentsMetadata

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 sucesso ou não. Não definido 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

Os códigos de coleção que estão sendo importados.
input_uri_prefix

string

O local dos documentos que estão sendo importados.

ImportDocumentsRequest

A solicitação para FirestoreAdmin.ImportDocuments.

Campos
name

string

Banco de dados no qual importar. Precisa estar no formato: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

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

string

Local dos arquivos exportados. Precisa corresponder ao output_uri_prefix de um ExportDocumentsResponse de uma exportação concluída. 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 ao qual este índice se aplica. Obrigatório.
fields[]

IndexField

Os campos a serem indexados.
state

State

O estado do índice. Apenas saída.

Estado

O estado de um índice. Durante a criação, um índice estará no estado CREATING. Se o índice for criado, ele vai fazer a transição para o estado READY. Se não for possível criar o índice, ele vai passar para o estado ERROR.

Enums
STATE_UNSPECIFIED O estado não foi especificado.
CREATING O índice está sendo criado. Há uma operação ativa de longa duração para o índice. O índice é atualizado durante a gravação de um documento. Pode haver alguns dados de índice.
READY O índice está pronto para ser usado. O índice é atualizado durante a gravação de um documento. O índice é totalmente preenchido com todos os documentos armazenados aos quais ele se aplica.
ERROR O índice estava sendo criado, mas algo deu errado. Não há uma operação de longa duração ativa para o índice, e a operação de longa duração concluída mais recentemente falhou. O índice não é atualizado durante a gravação de um documento. Pode haver alguns dados de índice.

IndexField

Um campo de um índice.

Campos
field_path

string

Caminho do campo. Precisa corresponder à especificação do caminho do campo descrita por [google.firestore.v1beta1.Document.fields][fields]. O caminho de campo especial __name__ pode ser usado sozinho ou no final de um caminho. __type__ só pode ser usado no fim do caminho.
mode

Mode

O modo do campo.

Modo

O modo determina como um campo é indexado.

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

IndexOperationMetadata

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 sucesso ou não. Não definido se a operação ainda estiver ativa.
index

string

O recurso de índice em que esta operação está atuando. Exemplo: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

O tipo de operação de índice.
cancelled

bool

Verdadeiro se o google.longrunning.Operation tiver sido cancelado. Se o cancelamento estiver em andamento, "cancelado" será "true", mas google.longrunning.Operation.done será "false".
document_progress

Progress

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

OperationType

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.

ListIndexesRequest

A solicitação para FirestoreAdmin.ListIndexes.

Campos
parent

string

O nome do banco de dados. Exemplo: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

O tamanho padrão de página de lista.
page_token

string

O token padrão de página de lista.

ListIndexesResponse

A resposta para FirestoreAdmin.ListIndexes.

Campos
indexes[]

Index

Os índices.
next_page_token

string

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

LocationMetadata

Esse tipo não tem campos.

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

OperationState

Os diversos 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 após o usuário chamar google.longrunning.Operations.CancelOperation na operação.
FINALIZING A solicitação foi processada e está na etapa de finalização.
SUCCESSFUL A solicitação foi concluída.
FAILED A solicitação foi processada, mas encontrou um erro.
CANCELLED O cancelamento da solicitação foi concluído após o usuário chamar google.longrunning.Operations.CancelOperation.

Progresso

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

Campos
work_completed

int64

Uma estimativa de quanto trabalho foi concluído. Esse valor pode ser maior do que work_estimated.
work_estimated

int64

Uma estimativa de quanto trabalho precisa ser realizado. Zero se a estimativa de trabalho não estiver disponível. Pode mudar à medida que o trabalho avança.