gRPC Client

Overview

You can use this Snap to interact with a gRPC (gRPC Remote Procedure Call) server to invoke its services. gRPC is a high-performance, open-source framework developed by Google that uses protocol buffers (Protobuf) as its interface definition language (IDL) to define the structure of the service and the messages exchanged between the client and server. Learn more . This Snap supports only Basic Authentication Account .



Prerequisites

grpcurl to interact with gRPC servers.

Limitations

This Snap does not support Auth Proxy. The grpcurl doesn’t support requests routed through a proxy.

Snap views

View Description Examples of upstream and downstream Snaps
Input The snap requires the user to input a gRPC server endpoint to connect to, and then select the specific service and method to access.
Output

The primary output is the response object, defined in the gRPC service's .proto file:

ResponseMessage object with fields like result and status_code.
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: gRPC Client

Example: gRPC Client
Server endpoint String/Expression Required. Specify the server to which the requests are sent.

Default value: N/A

Example: grpc-server.nia.snaplogic.com:12345
gRPC service String/Expression/ Suggestion Specify the gRPC service to be sent to the server.

Default value: N/A

Example: helloworld.HelloWorld
gRPC method String/Expression/ Suggestion Required. Specify the request to execute a gRPC method on the target server.

Default value: N/A

Example: helloworld.HelloWorld.SayHelloClientStream
Snap execution Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & Execute

Examples