# gRPC O **gRPC** permite a realização de chamadas a serviços gRPC do tipo unário e *client stream* via *payload* ou via arquivo. ## Parâmetros Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por [expressões *Double Braces*](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados com `(DB)`.
ParâmetroDescriçãoValor padrãoTipo de dado
Authenticate with client certificatesQuando ativado, pode selecionar autenticação de cliente com certificados de cliente (mTLS). Use o tipo de conta Certificate Chain.FalseBooleano
Authenticate with Google KeyQuando ativado, pode selecionar a autenticação do cliente com Google Key. Use o tipo de conta Google Key.FalseBooleano
Method TypeTipo de método que será utilizado na invocação do serviço. Os tipos de métodos suportados são Unary, Client Stream - via Payload e Client Stream - via File.UnaryString
URLEndereço de chamada do serviço gRPC. Ex: localhost:50051.N/AString
Headers (DB)Configura todos os tipos de headers necessários para chamada (ex.: Authorization: Bearer Co4ECg1FeGFtcGxlLnByb3RvIjwKDEh).N/APar de chave-valor
Custom AccountsDefina a conta a ser usada em expressões com Double Braces.N/AString
Service nameNome do serviço que está descrito dentro do arquivo de configuração .proto do servidor gRPC. Aprenda mais em Informações adicionais sobre parâmetros.N/AString
Method NameNome do método que está descrito dentro do arquivo de configuração .proto do servidor gRPC. Aprenda mais em Informações adicionais sobre parâmetros.N/AString
Proto Descriptor FileBase64 do arquivo “descriptor” do arquivo .proto. Aprenda mais em Informações adicionais sobre parâmetros.N/AString (Base64)
Payload (DB)O payload de requisição que será enviado ao servidor gRPC. Para o tipo de método Unary, deverá ser utlizado um objeto simples que contenha os campos definidos no arquivo .proto. Para o tipo de método Client Stream - via Payload deverá ser utilizado um array de objetos, onde cada item do array é uma mensagem a ser enviada ao servidor gRPC.N/AObjeto JSON ou Array
File NameNome do arquivo que será usado para enviar o payload no modo Client Stream - via File. Esse arquivo deverá ser um arquivo JSON que contenha um array e, dentro desse array, deve haver as mensagens a serem enviadas ao gRPC server de forma assíncrona (stream).N/AString
JSON PathExpressão JSON Path que irá determinar como será feita a leitura em stream do arquivo JSON. Somente para o tipo de método Client Stream - via File.N/AString
Connect TimeoutTempo de expiração da conexão com o servidor (em milissegundos).30000Inteiro
Request TimeoutTempo de expiração da chamada de requisição do componente com o servidor gRPC (em milissegundos).30000Inteiro
Fail On ErrorSe a opção estiver ativada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".FalseBooleano
### Informações adicionais sobre parâmetros #### Service Name Veja um exemplo de **Service Name** como “Greeter”: ```protobuf service Greeter { rpc helloMethod(Hellorequest) returns (HelloResponse); ​ } ``` #### Method Name Veja um exemplo de **Method Name** como “helloMethod”: ```protobuf service Greeter { rpc helloMethod(Hellorequest) returns (HelloResponse); ​ } ``` #### Proto Descriptor File Para usar esse parâmetro, o “descriptor” deve ser gerado primeiro a partir de um arquivo .proto. Para fazer isso, siga os passos abaixo: 1. Gere o arquivo "descriptor" executando o seguinte comando no diretório corrente que estiver localizado o arquivo .proto: * **Arquivo .proto do diretório:** Example.proto * **Nome do arquivo descriptor a ser gerado:** proto.desc ``` protoc --include_imports --descriptor_set_out=proto.desc Example.proto ``` Faça o download do compilador protoc em [Protocol Buffer Compiler Installation](https://grpc.io/docs/protoc-installation/). 2. Realize o *encode* deste arquivo para base64: ``` tLmRpZ2liZWUuZ3JwY0IMRGlnaWJlZVByb3RvUAGiAgNITFdiBnByb3RvMw== ``` 3. Informe o base64 na propriedade **Proto Descriptor File**. ## Fluxo de mensagens ### Entrada Espera-se um *payload* de entrada que será utilizado dentro do parâmetro **Payload** do componente. ### Saída Ao executar um componente SFTP utilizando as operações *download*, *upload* ou *move*, a seguinte estrutura de JSON será gerada: ``` { "response": {}, "success": "true" } ``` * **response:** JSON de resposta recebido do serviço gRPC. * **success:** "true" se houver uma conexão e o *script* for executado mesmo se retornar erros no *stderr*. ### Saída com erro ``` { "success": false, "message": "Something went wrong while trying to call the gRPC server", "error": "java.net.SocketTimeoutException: connect timed out" } ``` * **success:** “false” quando a operação falha. * **message:** mensagem sobre o erro. * **exception:** informação sobre o tipo de erro ocorrido. Para entender melhor o fluxo das mensagens na Plataforma, leia a [documentação sobre Processamento de mensagens](/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/messages-processing.md). ## Componente gRPC em ação ### Unary Dado o seguinte arquivo .proto: ```protobuf Example.proto ​ syntax = "proto3"; package digibee; ​ service Greeter { rpc unary (HelloRequest) returns (HelloReply) {} rpc clientStream (stream HelloRequest) returns (HelloReply) {} rpc serverStream (HelloRequest) returns (stream HelloReply) {} rpc Bidi(stream HelloRequest) returns (stream HelloReply); } ​ message HelloRequest { string name = 1; string address = 2; } ​ message HelloReply { string message = 1; int32 status = 2; } ``` Primeiramente, é preciso gerar o arquivo “descriptor”: 1. Dentro do diretório do arquivo, execute o comando: ``` protoc --include_imports --descriptor_set_out=proto.desc Example.proto ``` 2. Com o “descriptor” em mão, gere o base64 do arquivo proto.desc e adicione-o no campo **Proto Descriptor File**. Configurações do componente: **Method Type:** Unary **URL:** localhost:50051 **Service Name:** Greeter **Method Name:** unary **Proto Descriptor File:** \ **Payload:** ``` { "name": "Charles", "address": "390 Fifth Avenue" } ``` **Connect Timeout:** 30000 **Request Timeout:** 30000 **Fail On Error:** desabilitado **Resposta** ``` { "message": "Hi Charles", "status": 200 } ``` ### Client Stream - via Payload Dado o arquivo .proto: ```protobuf Example.proto ​ syntax = "proto3"; package digibee; ​ service Greeter { rpc unary (HelloRequest) returns (HelloReply) {} rpc clientStream (stream HelloRequest) returns (HelloReply) {} rpc serverStream (HelloRequest) returns (stream HelloReply) {} rpc Bidi(stream HelloRequest) returns (stream HelloReply); } ​ message HelloRequest { string name = 1; string address = 2; } ​ message HelloReply { string message = 1; int32 status = 2; } ``` Primeiramente, é preciso gerar o arquivo “descriptor”: 1. Dentro do diretório do arquivo, execute o comando: ``` protoc --include_imports --descriptor_set_out=proto.desc Example.proto ``` 2. Com o “descriptor” em mão, gere o base64 do arquivo proto.desc e adicione-o no campo **Proto Descriptor File**. Configurações do componente: **Method Type:** Client Stream - via Payload **URL:** localhost:50051 **Service Name:** Greeter **Method Name:** clientStream **Proto Descriptor File:** \ **Payload:** ``` [ { "name": "Charles", "address": "390 Fifth Avenue" }, { "name": "Paul", "address": "32 Seventh Avenue" }, { "name": "Yan", "address": "12 Fourth Avenue" } ] ``` **Connect Timeout:** 30000 **Request Timeout:** 30000 **Fail On Error:** desabilitado **Resposta** ``` { "message": "Hi Charles, Paul and Yan", "status": 200 } ``` ### Client Stream - via File Dado o seguinte arquivo .proto: ```protobuf Example.proto ​ syntax = "proto3"; package digibee; ​ service Greeter { rpc unary (HelloRequest) returns (HelloReply) {} rpc clientStream (stream HelloRequest) returns (HelloReply) {} rpc serverStream (HelloRequest) returns (stream HelloReply) {} rpc Bidi(stream HelloRequest) returns (stream HelloReply); } ​ message HelloRequest { string name = 1; string address = 2; } ​ message HelloReply { string message = 1; int32 status = 2; } ``` Primeiramente, é preciso gerar o arquivo “descriptor”: 1. Dentro do diretório do arquivo, execute o comando: ``` protoc --include_imports --descriptor_set_out=proto.desc Example.proto ``` 2. Com o “descriptor” em mão, gere o base64 do arquivo proto.desc e adicione-o no campo **Proto Descriptor File**. Configurações do componente: **Method Type:** Client Stream - via Payload **URL:** localhost:50051 **Service Name:** Greeter **Method Name:** clientStream **Proto Descriptor File:** \ **File Name:** file.json **File Name**: file.json {% code title="file.json" %} ``` { "infos": [ { "name": "Charles", "address": "390 Fifth Avenue" }, { "name": "Paul", "address": "32 Seventh Avenue" }, { "name": "Yan", "address": "12 Fourth Avenue" } ] } ``` {% endcode %} **JSON Path:** $.infos\[\*] **Connect Timeout:** 30000 **Request Timeout:** 30000 **Fail On Error:** desabilitado **Resposta** ``` { "message": "Hi Charles, Paul and Yan", "status": 200 } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/web-protocols/grpc.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.