v1

Documentation

Index

• Constants
• Variables
• func RegisterSideInputServer(s grpc.ServiceRegistrar, srv SideInputServer)
• type ReadyResponse
  • func (*ReadyResponse) Descriptor() ([]byte, []int)
  • func (x *ReadyResponse) GetReady() bool
  • func (*ReadyResponse) ProtoMessage()
  • func (x *ReadyResponse) ProtoReflect() protoreflect.Message
  • func (x *ReadyResponse) Reset()
  • func (x *ReadyResponse) String() string
• type SideInputClient
  • func NewSideInputClient(cc grpc.ClientConnInterface) SideInputClient
• type SideInputResponse
  • func (*SideInputResponse) Descriptor() ([]byte, []int)
  • func (x *SideInputResponse) GetNoBroadcast() bool
  • func (x *SideInputResponse) GetValue() []byte
  • func (*SideInputResponse) ProtoMessage()
  • func (x *SideInputResponse) ProtoReflect() protoreflect.Message
  • func (x *SideInputResponse) Reset()
  • func (x *SideInputResponse) String() string
• type SideInputServer
• type UnimplementedSideInputServer
  • func (UnimplementedSideInputServer) IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)
  • func (UnimplementedSideInputServer) RetrieveSideInput(context.Context, *emptypb.Empty) (*SideInputResponse, error)
• type UnsafeSideInputServer

Constants

const (
	SideInput_RetrieveSideInput_FullMethodName = "/sideinput.v1.SideInput/RetrieveSideInput"
	SideInput_IsReady_FullMethodName           = "/sideinput.v1.SideInput/IsReady"
)

Variables

var File_pkg_apis_proto_sideinput_v1_sideinput_proto protoreflect.FileDescriptor

var SideInput_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sideinput.v1.SideInput",
	HandlerType: (*SideInputServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "RetrieveSideInput",
			Handler:    _SideInput_RetrieveSideInput_Handler,
		},
		{
			MethodName: "IsReady",
			Handler:    _SideInput_IsReady_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "pkg/apis/proto/sideinput/v1/sideinput.proto",
}

SideInput_ServiceDesc is the grpc.ServiceDesc for SideInput service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSideInputServer

func RegisterSideInputServer(s grpc.ServiceRegistrar, srv SideInputServer)

Types

type ReadyResponse

type ReadyResponse struct {
	Ready bool `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

* ReadyResponse is the health check result.

func (*ReadyResponse) Descriptor

func (*ReadyResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadyResponse.ProtoReflect.Descriptor instead.

func (*ReadyResponse) GetReady

func (x *ReadyResponse) GetReady() bool

func (*ReadyResponse) ProtoMessage

func (*ReadyResponse) ProtoMessage()

func (*ReadyResponse) ProtoReflect

func (x *ReadyResponse) ProtoReflect() protoreflect.Message

func (*ReadyResponse) Reset

func (x *ReadyResponse) Reset()

func (*ReadyResponse) String

func (x *ReadyResponse) String() string

type SideInputClient

type SideInputClient interface {
	// RetrieveSideInput is the endpoint to retrieve the latest value of a given Side Input.
	RetrieveSideInput(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*SideInputResponse, error)
	// IsReady is the health check endpoint to indicate whether the service is ready to be used.
	IsReady(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ReadyResponse, error)
}

SideInputClient is the client API for SideInput service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

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.

func NewSideInputClient

func NewSideInputClient(cc grpc.ClientConnInterface) SideInputClient

type SideInputResponse

type SideInputResponse struct {

	// value represents the latest value of the side input payload
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// 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
	NoBroadcast bool `protobuf:"varint,2,opt,name=no_broadcast,json=noBroadcast,proto3" json:"no_broadcast,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SideInputResponse) Descriptor

func (*SideInputResponse) Descriptor() ([]byte, []int)

Deprecated: Use SideInputResponse.ProtoReflect.Descriptor instead.

func (*SideInputResponse) GetNoBroadcast

func (x *SideInputResponse) GetNoBroadcast() bool

func (*SideInputResponse) GetValue

func (x *SideInputResponse) GetValue() []byte

func (*SideInputResponse) ProtoMessage

func (*SideInputResponse) ProtoMessage()

func (*SideInputResponse) ProtoReflect

func (x *SideInputResponse) ProtoReflect() protoreflect.Message

func (*SideInputResponse) Reset

func (x *SideInputResponse) Reset()

func (*SideInputResponse) String

func (x *SideInputResponse) String() string

type SideInputServer

type SideInputServer interface {
	// RetrieveSideInput is the endpoint to retrieve the latest value of a given Side Input.
	RetrieveSideInput(context.Context, *emptypb.Empty) (*SideInputResponse, error)
	// IsReady is the health check endpoint to indicate whether the service is ready to be used.
	IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)
	// contains filtered or unexported methods
}

SideInputServer is the server API for SideInput service. All implementations must embed UnimplementedSideInputServer for forward compatibility

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.

type UnimplementedSideInputServer

type UnimplementedSideInputServer struct {
}

UnimplementedSideInputServer must be embedded to have forward compatible implementations.

func (UnimplementedSideInputServer) IsReady

func (UnimplementedSideInputServer) IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)

func (UnimplementedSideInputServer) RetrieveSideInput

func (UnimplementedSideInputServer) RetrieveSideInput(context.Context, *emptypb.Empty) (*SideInputResponse, error)

type UnsafeSideInputServer

type UnsafeSideInputServer interface {
	// contains filtered or unexported methods
}

UnsafeSideInputServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SideInputServer will result in compilation errors.