package sideinput.v1

Get desktop application:
View/edit binary Protocol Buffers messages

SideInput is the gRPC service for user-defined Side Inputs. It is used to propagate changes in the values of the provided Side Inputs which allows access to slow updated data or configuration without needing to retrieve it during each message processing. Through this service we should should be able to:- (1) Invoke retrieval request for a single Side Input parameter, which in turn should check for updates and return its latest value. (2) Provide a health check endpoint to indicate whether the service is ready to be used.

• rpc IsReady (google.protobuf.Empty, ReadyResponse)

  sideinput.proto:23

  IsReady is the health check endpoint to indicate whether the service is ready to be used.

  message ReadyResponse

  sideinput.proto:43

  * ReadyResponse is the health check result.

  • bool ready = 1

• rpc RetrieveSideInput (google.protobuf.Empty, SideInputResponse)

  sideinput.proto:20

  RetrieveSideInput is the endpoint to retrieve the latest value of a given Side Input.

  message SideInputResponse

  sideinput.proto:29

  * SideInputResponse represents a response to a given side input retrieval request.

  • bytes value = 1

    value represents the latest value of the side input payload

  • bool no_broadcast = 2

    noBroadcast indicates whether the side input value should be broadcasted to all True if value should not be broadcasted False if value should be broadcasted

  • optional common.Metadata metadata = 3

    Metadata is the metadata of the message