A tarefa Firestore - Busca de documentos permite recuperar o conteúdo de um único documento do Firestore. Por padrão, a tarefa Firestore - Busca de documentos busca o snapshot mais recente do documento do banco de dados do Firestore.
O Firestore é um banco de dados de documentos NoSQL criado para oferecer escalonamento automático, alto desempenho e facilidade no desenvolvimento de aplicativos.
Antes de começar
Execute as tarefas a seguir no projeto do Google Cloud antes de configurar a tarefa Firestore - Busca de documentos:
- Ativar a API Cloud Firestore (
firestore.googleapis.com). -
Criar um perfil de autenticação. A integração da Apigee usa um perfil de autenticação para se conectar a um endpoint de autenticação para a tarefa Firestore - Busca de documentos.
Para informações sobre como conceder papéis ou permissões adicionais a uma conta de serviço, consulte Como conceder, alterar e revogar acesso.
Configuração da tarefa Firestore - Busca de documentos
- Na interface da Apigee, selecione sua organização da Apigee.
- Clique em Desenvolver > Integrações.
- Selecione uma integração existente ou clique em Criar integração.
Caso você esteja criando uma nova integração, siga estas etapas:
- Digite um nome e uma descrição na caixa de diálogo Criar integração.
- Selecione uma Região para a integração na lista de regiões compatíveis.
- Clique em Criar.
Isso abre a integração na página do designer de integração.
- Na barra de navegação do designer de integração, clique em +Adicionar uma tarefa/gatilho> Tarefas para ver a lista de tarefas disponíveis.
- Clique e coloque o elemento Firestore - Busca de documentos no designer de integração.
- Clique no elemento Firestore - Busca de documentos do designer para conferir o painel de configuração de tarefa Firestore - Busca de documentos.
- Acesse Autenticação e selecione o perfil de autenticação que você quer usar.
Opcional. Se você não tiver criado um perfil de autenticação antes de configurar a tarefa, clique em + Novo perfil de autenticação e siga as etapas em Criar um novo perfil de autenticação.
- Acesse Entrada de tarefas e configure os campos de entrada exibidos com a tabela Parâmetros de entrada de tarefas.
As mudanças nos campos de entrada são salvas automaticamente.
Parâmetros de entrada da tarefa
Confira na tabela a seguir os parâmetros de entrada da tarefa Firestore - Busca de documentos:
| Propriedade | Tipo de dados | Descrição |
|---|---|---|
| Região | String | Local do banco de dados do Firestore. Por exemplo, us-central1. |
| ProjectsId | String | É o ID do seu projeto no Google Cloud. |
| DatabasesId | String | ID do banco de dados do Firestore. |
| DocumentsId | String | Caminho ou local do documento do Firestore. |
Para obter informações sobre os parâmetros de consulta opcionais disponíveis, consulte Parâmetros de consulta.
Saída da tarefa
A tarefa Firestore - Busca de documentos retorna os dados do documento no formato codificado em base64. É necessário decodificar o valor codificado em base64 para receber a string de saída.
Estratégia de solução de erros
A estratégia de solução de erros para uma tarefa especifica a ação a ser realizada se a tarefa falhar devido a um erro temporário. Para mais informações sobre como usar uma estratégia de tratamento de erros e conhecer os diferentes tipos de estratégias de tratamento de erros, consulte Estratégias de tratamento de erros.
A seguir
- Adicione bordas e condições de borda.
- Teste e publique sua integração.
- Configure um gatilho.
- Adicione uma tarefa de mapeamento de dados.
- Confira todas as tarefas para os serviços do Google Cloud.