Documentation ¶
Index ¶
- Variables
- func RegisterUserDefinedFunctionServer(s grpc.ServiceRegistrar, srv UserDefinedFunctionServer)
- type DatumRequest
- func (*DatumRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DatumRequest) GetEventTime() *EventTime
- func (x *DatumRequest) GetKeys() []string
- func (x *DatumRequest) GetMetadata() *Metadata
- func (x *DatumRequest) GetValue() []byte
- func (x *DatumRequest) GetWatermark() *Watermark
- func (*DatumRequest) ProtoMessage()
- func (x *DatumRequest) ProtoReflect() protoreflect.Message
- func (x *DatumRequest) Reset()
- func (x *DatumRequest) String() string
- type DatumResponse
- func (*DatumResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DatumResponse) GetEventTime() *EventTime
- func (x *DatumResponse) GetKeys() []string
- func (x *DatumResponse) GetTags() []string
- func (x *DatumResponse) GetValue() []byte
- func (x *DatumResponse) GetWatermark() *Watermark
- func (*DatumResponse) ProtoMessage()
- func (x *DatumResponse) ProtoReflect() protoreflect.Message
- func (x *DatumResponse) Reset()
- func (x *DatumResponse) String() string
- type DatumResponseList
- func (*DatumResponseList) Descriptor() ([]byte, []int)deprecated
- func (x *DatumResponseList) GetElements() []*DatumResponse
- func (*DatumResponseList) ProtoMessage()
- func (x *DatumResponseList) ProtoReflect() protoreflect.Message
- func (x *DatumResponseList) Reset()
- func (x *DatumResponseList) String() string
- type EventTime
- type Metadata
- type ReadyResponse
- type UnimplementedUserDefinedFunctionServer
- func (UnimplementedUserDefinedFunctionServer) IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)
- func (UnimplementedUserDefinedFunctionServer) MapFn(context.Context, *DatumRequest) (*DatumResponseList, error)
- func (UnimplementedUserDefinedFunctionServer) MapTFn(context.Context, *DatumRequest) (*DatumResponseList, error)
- func (UnimplementedUserDefinedFunctionServer) ReduceFn(UserDefinedFunction_ReduceFnServer) error
- type UnsafeUserDefinedFunctionServer
- type UserDefinedFunctionClient
- type UserDefinedFunctionServer
- type UserDefinedFunction_ReduceFnClient
- type UserDefinedFunction_ReduceFnServer
- type Watermark
Constants ¶
This section is empty.
Variables ¶
var File_pkg_apis_proto_function_v1_udfunction_proto protoreflect.FileDescriptor
var UserDefinedFunction_ServiceDesc = grpc.ServiceDesc{ ServiceName: "function.v1.UserDefinedFunction", HandlerType: (*UserDefinedFunctionServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "MapFn", Handler: _UserDefinedFunction_MapFn_Handler, }, { MethodName: "MapTFn", Handler: _UserDefinedFunction_MapTFn_Handler, }, { MethodName: "IsReady", Handler: _UserDefinedFunction_IsReady_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "ReduceFn", Handler: _UserDefinedFunction_ReduceFn_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "pkg/apis/proto/function/v1/udfunction.proto", }
UserDefinedFunction_ServiceDesc is the grpc.ServiceDesc for UserDefinedFunction service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterUserDefinedFunctionServer ¶
func RegisterUserDefinedFunctionServer(s grpc.ServiceRegistrar, srv UserDefinedFunctionServer)
Types ¶
type DatumRequest ¶ added in v0.4.3
type DatumRequest struct { Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"` Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` EventTime *EventTime `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"` Watermark *Watermark `protobuf:"bytes,4,opt,name=watermark,proto3" json:"watermark,omitempty"` Metadata *Metadata `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"` // contains filtered or unexported fields }
* Datum represents a datum element.
func (*DatumRequest) Descriptor
deprecated
added in
v0.4.3
func (*DatumRequest) Descriptor() ([]byte, []int)
Deprecated: Use DatumRequest.ProtoReflect.Descriptor instead.
func (*DatumRequest) GetEventTime ¶ added in v0.4.3
func (x *DatumRequest) GetEventTime() *EventTime
func (*DatumRequest) GetKeys ¶ added in v0.4.3
func (x *DatumRequest) GetKeys() []string
func (*DatumRequest) GetMetadata ¶ added in v0.4.3
func (x *DatumRequest) GetMetadata() *Metadata
func (*DatumRequest) GetValue ¶ added in v0.4.3
func (x *DatumRequest) GetValue() []byte
func (*DatumRequest) GetWatermark ¶ added in v0.4.3
func (x *DatumRequest) GetWatermark() *Watermark
func (*DatumRequest) ProtoMessage ¶ added in v0.4.3
func (*DatumRequest) ProtoMessage()
func (*DatumRequest) ProtoReflect ¶ added in v0.4.3
func (x *DatumRequest) ProtoReflect() protoreflect.Message
func (*DatumRequest) Reset ¶ added in v0.4.3
func (x *DatumRequest) Reset()
func (*DatumRequest) String ¶ added in v0.4.3
func (x *DatumRequest) String() string
type DatumResponse ¶ added in v0.4.3
type DatumResponse struct { Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"` Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` EventTime *EventTime `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"` Watermark *Watermark `protobuf:"bytes,4,opt,name=watermark,proto3" json:"watermark,omitempty"` Tags []string `protobuf:"bytes,5,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
* Datum represents a datum element.
func (*DatumResponse) Descriptor
deprecated
added in
v0.4.3
func (*DatumResponse) Descriptor() ([]byte, []int)
Deprecated: Use DatumResponse.ProtoReflect.Descriptor instead.
func (*DatumResponse) GetEventTime ¶ added in v0.4.3
func (x *DatumResponse) GetEventTime() *EventTime
func (*DatumResponse) GetKeys ¶ added in v0.4.3
func (x *DatumResponse) GetKeys() []string
func (*DatumResponse) GetTags ¶ added in v0.4.3
func (x *DatumResponse) GetTags() []string
func (*DatumResponse) GetValue ¶ added in v0.4.3
func (x *DatumResponse) GetValue() []byte
func (*DatumResponse) GetWatermark ¶ added in v0.4.3
func (x *DatumResponse) GetWatermark() *Watermark
func (*DatumResponse) ProtoMessage ¶ added in v0.4.3
func (*DatumResponse) ProtoMessage()
func (*DatumResponse) ProtoReflect ¶ added in v0.4.3
func (x *DatumResponse) ProtoReflect() protoreflect.Message
func (*DatumResponse) Reset ¶ added in v0.4.3
func (x *DatumResponse) Reset()
func (*DatumResponse) String ¶ added in v0.4.3
func (x *DatumResponse) String() string
type DatumResponseList ¶ added in v0.4.3
type DatumResponseList struct { Elements []*DatumResponse `protobuf:"bytes,1,rep,name=elements,proto3" json:"elements,omitempty"` // contains filtered or unexported fields }
* DatumList represents a list of datum elements.
func (*DatumResponseList) Descriptor
deprecated
added in
v0.4.3
func (*DatumResponseList) Descriptor() ([]byte, []int)
Deprecated: Use DatumResponseList.ProtoReflect.Descriptor instead.
func (*DatumResponseList) GetElements ¶ added in v0.4.3
func (x *DatumResponseList) GetElements() []*DatumResponse
func (*DatumResponseList) ProtoMessage ¶ added in v0.4.3
func (*DatumResponseList) ProtoMessage()
func (*DatumResponseList) ProtoReflect ¶ added in v0.4.3
func (x *DatumResponseList) ProtoReflect() protoreflect.Message
func (*DatumResponseList) Reset ¶ added in v0.4.3
func (x *DatumResponseList) Reset()
func (*DatumResponseList) String ¶ added in v0.4.3
func (x *DatumResponseList) String() string
type EventTime ¶
type EventTime struct { // event_time is the time associated with each datum. EventTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"` // contains filtered or unexported fields }
func (*EventTime) Descriptor
deprecated
func (*EventTime) GetEventTime ¶
func (x *EventTime) GetEventTime() *timestamppb.Timestamp
func (*EventTime) ProtoMessage ¶
func (*EventTime) ProtoMessage()
func (*EventTime) ProtoReflect ¶
func (x *EventTime) ProtoReflect() protoreflect.Message
type Metadata ¶ added in v0.4.1
type Metadata struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` NumDelivered uint64 `protobuf:"varint,2,opt,name=num_delivered,json=numDelivered,proto3" json:"num_delivered,omitempty"` // contains filtered or unexported fields }
* Metadata of a datum element.
func (*Metadata) Descriptor
deprecated
added in
v0.4.1
func (*Metadata) GetNumDelivered ¶ added in v0.4.1
func (*Metadata) ProtoMessage ¶ added in v0.4.1
func (*Metadata) ProtoMessage()
func (*Metadata) ProtoReflect ¶ added in v0.4.1
func (x *Metadata) ProtoReflect() protoreflect.Message
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
deprecated
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 UnimplementedUserDefinedFunctionServer ¶
type UnimplementedUserDefinedFunctionServer struct { }
UnimplementedUserDefinedFunctionServer must be embedded to have forward compatible implementations.
func (UnimplementedUserDefinedFunctionServer) IsReady ¶
func (UnimplementedUserDefinedFunctionServer) IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)
func (UnimplementedUserDefinedFunctionServer) MapFn ¶
func (UnimplementedUserDefinedFunctionServer) MapFn(context.Context, *DatumRequest) (*DatumResponseList, error)
func (UnimplementedUserDefinedFunctionServer) MapTFn ¶ added in v0.3.1
func (UnimplementedUserDefinedFunctionServer) MapTFn(context.Context, *DatumRequest) (*DatumResponseList, error)
type UnsafeUserDefinedFunctionServer ¶
type UnsafeUserDefinedFunctionServer interface {
// contains filtered or unexported methods
}
UnsafeUserDefinedFunctionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UserDefinedFunctionServer will result in compilation errors.
type UserDefinedFunctionClient ¶
type UserDefinedFunctionClient interface { // MapFn applies a function to each datum element. MapFn(ctx context.Context, in *DatumRequest, opts ...grpc.CallOption) (*DatumResponseList, error) // MapTFn applies a function to each datum element. // In addition to map function, MapTFn also supports assigning a new event time to datum. // MapTFn can be used only at source vertex by source data transformer. MapTFn(ctx context.Context, in *DatumRequest, opts ...grpc.CallOption) (*DatumResponseList, error) // ReduceFn applies a reduce function to a datum stream. ReduceFn(ctx context.Context, opts ...grpc.CallOption) (UserDefinedFunction_ReduceFnClient, error) // IsReady is the heartbeat endpoint for gRPC. IsReady(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ReadyResponse, error) }
UserDefinedFunctionClient is the client API for UserDefinedFunction 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.
func NewUserDefinedFunctionClient ¶
func NewUserDefinedFunctionClient(cc grpc.ClientConnInterface) UserDefinedFunctionClient
type UserDefinedFunctionServer ¶
type UserDefinedFunctionServer interface { // MapFn applies a function to each datum element. MapFn(context.Context, *DatumRequest) (*DatumResponseList, error) // MapTFn applies a function to each datum element. // In addition to map function, MapTFn also supports assigning a new event time to datum. // MapTFn can be used only at source vertex by source data transformer. MapTFn(context.Context, *DatumRequest) (*DatumResponseList, error) // ReduceFn applies a reduce function to a datum stream. ReduceFn(UserDefinedFunction_ReduceFnServer) error // IsReady is the heartbeat endpoint for gRPC. IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error) // contains filtered or unexported methods }
UserDefinedFunctionServer is the server API for UserDefinedFunction service. All implementations must embed UnimplementedUserDefinedFunctionServer for forward compatibility
type UserDefinedFunction_ReduceFnClient ¶
type UserDefinedFunction_ReduceFnClient interface { Send(*DatumRequest) error Recv() (*DatumResponseList, error) grpc.ClientStream }
type UserDefinedFunction_ReduceFnServer ¶
type UserDefinedFunction_ReduceFnServer interface { Send(*DatumResponseList) error Recv() (*DatumRequest, error) grpc.ServerStream }
type Watermark ¶
type Watermark struct { // watermark is the monotonically increasing time which denotes completeness for the given time for the given vertex. Watermark *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=watermark,proto3" json:"watermark,omitempty"` // future we can add LATE, ON_TIME etc. // contains filtered or unexported fields }
func (*Watermark) Descriptor
deprecated
func (*Watermark) GetWatermark ¶
func (x *Watermark) GetWatermark() *timestamppb.Timestamp
func (*Watermark) ProtoMessage ¶
func (*Watermark) ProtoMessage()
func (*Watermark) ProtoReflect ¶
func (x *Watermark) ProtoReflect() protoreflect.Message