Package google.firestore.admin.v1beta2

string

Um nome pai no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Index

O índice composto a ser criado.

string

Um nome no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Hora em que a operação começou.

Timestamp

Hora em que a 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, desta operação.

Progress

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

string

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

string

Para onde as entidades são exportadas.

string

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

string

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

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.

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.

string

Um nome de campo no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Ele pode ser um nome de campo simples, como 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 do 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),[,]`, bem como caracteres ASCII.

Exemplos: (Observação: os comentários aqui estão escritos em sintaxe 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*`, não qualquer campo.

Uma 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 têm a própria configuração de índice Field.

IndexConfig

A configuração de índice para este campo. Se não for definida, a indexação de campo vai 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.

Index

Os índices compatíveis com este campo.

bool

Apenas saída. Quando verdadeiro, a configuração de índice de Field é definida a partir da 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 da Field que define a configuração de índice desse campo (quando uses_ancestor_config for verdadeiro) ou em que ele seria definido se o campo não tivesse configuração de índice (quando uses_ancestor_config fosse falso).

bool

Saída apenas quando verdadeiro, a configuração de índice de Field está em processo de reversão. Depois de concluída, a configuração do índice vai fazer a transição para o mesmo estado do campo especificado por ancestor_field. Nesse momento, uses_ancestor_config será true e reverting será false.

Timestamp

Hora em que a operação começou.

Timestamp

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

string

O recurso de campo em que a operação está agindo. 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

Estado da operação.

Progress

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

Progress

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

ChangeType

Especifica como o índice está sendo alterado.

Index

O índice que está sendo alterado.

string

Um nome no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string

Um nome no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Hora em que a operação começou.

Timestamp

Hora em que a 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, desta operação.

Progress

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

string

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

string

O local dos documentos que estão sendo importados.

string

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

string

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. Precisa corresponder ao output_uri_prefix de um ExportDocumentsResponse de uma exportação concluída. Consulte: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

string

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

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

Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todos os conjuntos descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que este índice.

IndexField

Os campos aceitos por esse índice.

Para índices compostos, sempre há dois ou mais 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 oferece suporte para ordenação pela ordem especificada ou comparação usando =, <, <=, >, >=.

ArrayConfig

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

Timestamp

Hora em que a operação começou.

Timestamp

Hora em que a 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á atuando. Exemplo: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

OperationState

Estado da operação.

Progress

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

Progress

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

string

Um nome pai no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

O filtro que será aplicado aos resultados da lista. No momento, o FirestoreAdmin.ListFields só é compatível com os campos de fichas que foram modificados explicitamente. Para emitir essa consulta, chame FirestoreAdmin.ListFields com o filtro definido como indexConfig.usesAncestorConfig:false.

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 acessar 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, essa será a última página.

string

Um nome pai no formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

O filtro que 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 acessar 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, essa será a última página.

int64

A quantidade de trabalho estimada.

int64

A quantidade de trabalho concluído.

Field

O campo a ser atualizado.

FieldMask

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