package sink.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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

  sink.proto:17

  IsReady is the heartbeat endpoint for gRPC.

  message ReadyResponse

  sink.proto:54

  * ReadyResponse is the health check result.

  • bool ready = 1

• rpc SinkFn (stream SinkRequest, stream SinkResponse)

  sink.proto:14

  SinkFn writes the request to a user defined sink.

  message SinkRequest

  sink.proto:23

  * SinkRequest represents a request element.

  • optional SinkRequest.Request request = 1

    Required field indicating the request.

  • optional TransmissionStatus status = 2

    Required field indicating the status of the request. If eot is set to true, it indicates the end of transmission.

  • optional Handshake handshake = 3

    optional field indicating the handshake message.

  message SinkResponse

  sink.proto:79

  * SinkResponse is the individual response of each message written to the sink.

  • repeated SinkResponse.Result results = 1

  • optional Handshake handshake = 2

  • optional TransmissionStatus status = 3

Handshake message between client and server to indicate the start of transmission.

Used in: SinkRequest, SinkResponse

• bool sot = 1

  Required field indicating the start of transmission.

Used in: SinkRequest

• repeated string keys = 1

• bytes value = 2

• optional google.protobuf.Timestamp event_time = 3

• optional google.protobuf.Timestamp watermark = 4

• string id = 5

• map<string, string> headers = 6

• optional common.Metadata metadata = 7

  Metadata is the metadata of the message

Used in: SinkResponse

• string id = 1

  id is the ID of the message, can be used to uniquely identify the message.

• Status status = 2

  status denotes the status of persisting to sink. It can be SUCCESS, FAILURE, or FALLBACK.

• string err_msg = 3

  err_msg is the error message, set it if success is set to false.

• optional bytes serve_response = 4

• optional Result.Message on_success_msg = 5

  on_success_msg is the message to be sent to on_success sink.

Used in: Result

• bytes value = 1

• repeated string keys = 2

• optional common.Metadata metadata = 3

Status is the status of the response.

Used in: SinkResponse.Result

• SUCCESS = 0

• FAILURE = 1

• FALLBACK = 2

• SERVE = 3

• ON_SUCCESS = 4

* TransmissionStatus is the status of the transmission.

Used in: SinkRequest, SinkResponse

• bool eot = 1