Esta página foi traduzida pela API Cloud Translation.

Solace

O conector do Solace fornece conectividade com o Solace.

Antes de começar

Antes de usar o conector Solace, faça o seguinte:

No seu projeto do Google Cloud, faça o seguinte:
- Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acessar a página "Conexões"
Clique em + CRIAR NOVO para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para conferir a lista de todas as regiões com suporte, consulte Locais.
2. Clique em Próxima.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Solace na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
3. No campo Nome da conexão, insira um nome para a instância de conexão
  Os nomes de conexão precisam atender aos seguintes critérios:
  - Os nomes de conexões podem usar letras, números ou hifens.
  - As letras precisam ser minúsculas.
  - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das conexões não podem ter mais de 49 caracteres.
  - Para conectores que oferecem suporte à assinatura de eventos, os nomes de conexão não podem começar com o prefixo "goog".
4. Como opção, insira uma Descrição para a instância de conexão.
5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
6. Se quiser usar a conexão para inscrições de eventos, selecione Ativar inscrição de eventos. Selecionando essa opção ativa a inscrição no evento com ações.
  Observação: a opção Enable only event subscription não é aceita para essa conexão.
7. VPN de mensagem: a VPN de mensagem do roteador de mensagens do Solace Pub/Sub+ a que você quer se conectar. Uma conexão é específica para uma VPN de mensagem. Se você tiver muitas VPNs de mensagens, crie uma conexão separada para cada uma delas.
8. Nome da fila padrão: o nome da fila padrão. Pode ser substituído durante a execução da ação.
9. Nome do tópico padrão: o nome do tópico a ser conectado.
10. Opcionalmente, defina as Configurações do nó de conexão:
  - Número mínimo de nós: digite o número mínimo de nós de conexão.
  - Número máximo de nós: digite o número máximo de nós de conexão.
  Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
11. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
12. Clique em Próxima.
Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
1. Tipo de destino: selecione um Tipo de destino.
  - Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
  - Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
    Observação : para entender como criar um anexo de endpoint, consulte Anexo de serviço PSC e anexo de endpoint. Depois de ter criado o anexo de endpoint, ele vai aparecer na lista Anexo do endpoint.
  Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
  
  Observação: este conector aceita apenas um destino.
2. Clique em Próxima.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  A conexão do Solace oferece suporte aos seguintes tipos de autenticação:
  - Anônimo
  - Nome de usuário e senha
2. Clique em Próxima.
Na seção Detalhes da assinatura do evento, configure os detalhes relacionados ao evento.
- Insira a configuração de mensagens inativas. Se você configurar mensagens inativas, a conexão gravará os eventos não processados para o tópico do Pub/Sub especificado. Digite os seguintes detalhes:
  1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas do Pub/Sub.
  2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

Anônimo
Se você quiser usar o login anônimo, selecioneNão disponível.

Nome de usuário e senha
- Nome de usuário: o nome de usuário do Solace que será usado para a conexão.
- Senha: o Secret do Secret Manager que contém a senha associada ao nome de usuário do Solace.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.
Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
- Lista
- Receber
- Criar
- Atualizar
- Excluir
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.
Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

A conexão do Solace é compatível com as seguintes ações:

sendMessage: envia uma mensagem para uma fila.
requestReply: envia uma mensagem para uma fila e também especifica a fila em que a pessoa que responde vai gravar a resposta.

Ação sendMessage

As tabelas a seguir descrevem os parâmetros de entrada e saída da ação sendMessage.

Parâmetros de entrada da ação sendMessage

Nome do parâmetro	Obrigatório	Tipo de dados	Descrição
mensagem	Sim	String	Mensagem a ser enviada para a fila do Solace. Atualmente, o tamanho máximo da mensagem aceito é de 10 MB.
queueName	Não	String	Nome da fila do Solace. Se você não especificar um nome de fila, será usado o nome padrão definido durante a criação da conexão.
messageContentType	Sim	String	Tipo de conteúdo da mensagem, que você pode especificar como `Text` ou `Bytes`. Defina o tipo como `Bytes` se estiver enviando dados binários. Para enviar uma mensagem em um formato binário, faça o seguinte: Codifique a mensagem binária como uma string Base64 e defina o parâmetro `message` como o valor codificado. Defina o valor do parâmetro `messageContentType` como `Bytes`.
messageType	Sim	String	Tipo de mensagem que você pode especificar como `Datagram` ou `Reply`.
topicName	Não	String	Nome do tópico do Solace. Se você não especificar um nome de tópico, será usado o nome padrão da fila especificado durante a criação da conexão.

Parâmetros de saída da ação sendMessage

Nome do parâmetro	Tipo de dados	Descrição
messageId	String	ID da mensagem enviada.

Exemplos

O payload a seguir é usado para enviar uma mensagem de texto de datagrama para uma fila.

  {
    "message": "Hello world",
    "messageContentType": "Text",
    "messageType": "Datagram",
    "queueName": "solace-queue"
  }

O payload de saída é semelhante ao seguinte:

[{
    "messageId": "ID:414d51207365637572*******6501db3640"
}]

O payload a seguir é usado para enviar uma mensagem de byte de resposta a um tópico.

{
    "message": "NDggNjUgNmMgNmMgNmYgMjAgNTcgNmYgNzIgNmMgNjQ=",
    "messageContentType": "Bytes",
    "messageType": "Reply",
    "topicName": "solace-topic"
}

O payload de saída é semelhante a este:

[{
  "messageId": "ID:414d512073656375726561707068656ce595386501db3640"
}]

Ação requestReply

As tabelas a seguir descrevem os parâmetros de entrada e saída da ação requestReply.

Parâmetros de entrada da ação requestReply

Nome do parâmetro	Obrigatório	Tipo de dados	Descrição
mensagem	Sim	String	Mensagem a ser enviada para a fila do Solace. O tamanho máximo da mensagem aceito é de 10 MB.
queueName	Não	String	Nome da fila do Solace. Se você não especificar um nome de fila, será usado o nome padrão definido durante a criação da conexão.
messageContentType	Sim	String	Tipo de conteúdo da mensagem, que você pode especificar como `Text` ou `Bytes`. Defina o tipo como `Bytes` se estiver enviando dados binários. Para enviar uma mensagem em um formato binário, faça o seguinte: Codifique a mensagem binária como uma string Base64 e defina o parâmetro `message` como o valor codificado. Defina o valor do parâmetro `messageContentType` como `Bytes`.
replyToQueue	Sim	String	Fila em que a pessoa que responde vai gravar a resposta.
replyTimeout	Sim	String	Tempo (em milissegundos) que o conector aguarda a resposta na fila de respostas. O valor máximo suportado é de 180.000 milissegundos (3 minutos). Se a fila de respostas receber uma mensagem após o tempo limite, essa mensagem não será processada pelo conector. No entanto, é possível visualizar os detalhes da mensagem expirada nos registros de execução da integração. Observação: a definição de um valor de tempo limite maior pode afetar o desempenho do conector.

Parâmetros de saída da ação requestReply

Nome do parâmetro	Tipo de dados	Descrição
replyMessage	String	Mensagem de resposta da pessoa que responde.

Exemplos

O payload a seguir é usado para enviar a mensagem de resposta da pessoa.

{
  "message": "Hello world",
  "messageContentType": "Text",
  "queueName": "solace-queue",
  "replyToQueue": "solace-reply-queue",
  "replyTimeout": 10
}

O payload de saída é semelhante a este:

{
    "replyMessage": "Message received"
}

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
default_queue_name	STRING	Falso	O nome da fila padrão. Pode ser substituído durante a execução da ação.
default_topic_name	STRING	Falso	O nome do tópico padrão. Pode ser substituído durante a execução da ação.
queue_manager_name	STRING	Verdadeiro	O nome do gerenciador de filas ao qual se conectar.
channel_name	STRING	Verdadeiro	O canal em que conectar o gerenciador de filas.

Usar a conexão da Solace em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como acessar os registros do conector.