/
gRPC Client

gRPC Client

In this article

Overview

You can use this Snap to interact with a gRPC (Google 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.

grpc-client-overview.png

 

Snap Type

The gRPC Client Snap is a Read-type Snap that reads the gRPC response from the server.

Prerequisites

grpcurl to interact with gRPC servers.

Support for Ultra Pipelines  

Works in Ultra Tasks

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

 

  • Min: 0

  • Max: 1

  • Mapper

  • JSON Generator

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

Document

 

  • Min: 0

  • Max: 1

  • Mapper

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • 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

  • Expression : Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Suggestion : Populates a list of values dynamically based on your Account configuration.

  • Upload : Uploads files. Learn more.

Learn more about the icons in the Snap Settings dialog.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: gRPC Client
ExamplegRPC Client

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

 

Server endpoint

 

Default Value: N/A
Example: grpc-server.nia.snaplogic.com:12345

String/Expression

Specify the server to which the requests are sent.

gRPC service


Default Value: N/A
Example: helloworld.HelloWorld

String/Expression/Suggestion

Specify the gRPC service to be sent to the server.

gRPC method


Default Value: N/A
Example: helloworld.HelloWorld.SayHelloClientStream

String/Expression/Suggestion

Specify the request to execute a gRPC method on the target server.

Snap Execution

Default Value
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap based on Preview Document Count value in User settings 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.

Examples

 

  File Modified
No files shared here yet.

Snap Pack History


Related Content