v1

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 16, 2022 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_pkg_apis_proto_sink_v1_udsink_proto protoreflect.FileDescriptor
View Source 
var UserDefinedSink_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sink.v1.UserDefinedSink",
	HandlerType: (*UserDefinedSinkServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "IsReady",
			Handler:    _UserDefinedSink_IsReady_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "SinkFn",
			Handler:       _UserDefinedSink_SinkFn_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "pkg/apis/proto/sink/v1/udsink.proto",
}

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

Functions

func RegisterUserDefinedSinkServer added in v0.2.3 

func RegisterUserDefinedSinkServer(s grpc.ServiceRegistrar, srv UserDefinedSinkServer)

Types

type Datum added in v0.2.3 

type Datum struct {
	Key       string     `protobuf:"bytes,1,opt,name=key,proto3" json:"key,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"`
	Id        string     `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

* Datum represents a datum element.

func (*Datum) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use Datum.ProtoReflect.Descriptor instead.

func (*Datum) GetEventTime added in v0.2.3 

func (x *Datum) GetEventTime() *EventTime

func (*Datum) GetId added in v0.2.3 

func (x *Datum) GetId() string

func (*Datum) GetKey added in v0.2.3 

func (x *Datum) GetKey() string

func (*Datum) GetValue added in v0.2.3 

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

func (*Datum) GetWatermark added in v0.2.3 

func (x *Datum) GetWatermark() *Watermark

func (*Datum) ProtoMessage added in v0.2.3 

func (*Datum) ProtoMessage()

func (*Datum) ProtoReflect added in v0.2.3 

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

func (*Datum) Reset added in v0.2.3 

func (x *Datum) Reset()

func (*Datum) String added in v0.2.3 

func (x *Datum) String() string

type EventTime added in v0.2.3 

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 added in v0.2.3 

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

Deprecated: Use EventTime.ProtoReflect.Descriptor instead.

func (*EventTime) GetEventTime added in v0.2.3 

func (x *EventTime) GetEventTime() *timestamppb.Timestamp

func (*EventTime) ProtoMessage added in v0.2.3 

func (*EventTime) ProtoMessage()

func (*EventTime) ProtoReflect added in v0.2.3 

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

func (*EventTime) Reset added in v0.2.3 

func (x *EventTime) Reset()

func (*EventTime) String added in v0.2.3 

func (x *EventTime) String() string

type ReadyResponse added in v0.2.3 

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 added in v0.2.3 

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

Deprecated: Use ReadyResponse.ProtoReflect.Descriptor instead.

func (*ReadyResponse) GetReady added in v0.2.3 

func (x *ReadyResponse) GetReady() bool

func (*ReadyResponse) ProtoMessage added in v0.2.3 

func (*ReadyResponse) ProtoMessage()

func (*ReadyResponse) ProtoReflect added in v0.2.3 

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

func (*ReadyResponse) Reset added in v0.2.3 

func (x *ReadyResponse) Reset()

func (*ReadyResponse) String added in v0.2.3 

func (x *ReadyResponse) String() string

type Response added in v0.2.3 

type Response struct {

	// id is the ID of the message, can be used to uniquely identify the message.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// success denotes the status of persisting to disk. if set to false, it means writing to sink for the message failed.
	Success bool `protobuf:"varint,2,opt,name=success,proto3" json:"success,omitempty"`
	// err_msg is the error message, set it if success is set to false.
	ErrMsg string `protobuf:"bytes,3,opt,name=err_msg,json=errMsg,proto3" json:"err_msg,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Response) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetErrMsg added in v0.2.3 

func (x *Response) GetErrMsg() string

func (*Response) GetId added in v0.2.3 

func (x *Response) GetId() string

func (*Response) GetSuccess added in v0.2.3 

func (x *Response) GetSuccess() bool

func (*Response) ProtoMessage added in v0.2.3 

func (*Response) ProtoMessage()

func (*Response) ProtoReflect added in v0.2.3 

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

func (*Response) Reset added in v0.2.3 

func (x *Response) Reset()

func (*Response) String added in v0.2.3 

func (x *Response) String() string

type ResponseList added in v0.2.3 

type ResponseList struct {
	Responses []*Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	// contains filtered or unexported fields
}

* ResponseList is the list of responses. The number of elements in this list will be equal to the number of Datum elements passed to the SinkFn.

func (*ResponseList) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use ResponseList.ProtoReflect.Descriptor instead.

func (*ResponseList) GetResponses added in v0.2.3 

func (x *ResponseList) GetResponses() []*Response

func (*ResponseList) ProtoMessage added in v0.2.3 

func (*ResponseList) ProtoMessage()

func (*ResponseList) ProtoReflect added in v0.2.3 

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

func (*ResponseList) Reset added in v0.2.3 

func (x *ResponseList) Reset()

func (*ResponseList) String added in v0.2.3 

func (x *ResponseList) String() string

type UnimplementedUserDefinedSinkServer added in v0.2.3 

type UnimplementedUserDefinedSinkServer struct {
}

UnimplementedUserDefinedSinkServer must be embedded to have forward compatible implementations.

func (UnimplementedUserDefinedSinkServer) IsReady added in v0.2.3 

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

func (UnimplementedUserDefinedSinkServer) SinkFn added in v0.2.3 

func (UnimplementedUserDefinedSinkServer) SinkFn(UserDefinedSink_SinkFnServer) error

type UnsafeUserDefinedSinkServer added in v0.2.3 

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

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

type UserDefinedSinkClient added in v0.2.3 

type UserDefinedSinkClient interface {
	// SinkFn writes the Datum to a user defined sink.
	SinkFn(ctx context.Context, opts ...grpc.CallOption) (UserDefinedSink_SinkFnClient, error)
	// IsReady is the heartbeat endpoint for gRPC.
	IsReady(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ReadyResponse, error)
}

UserDefinedSinkClient is the client API for UserDefinedSink 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 NewUserDefinedSinkClient added in v0.2.3 

func NewUserDefinedSinkClient(cc grpc.ClientConnInterface) UserDefinedSinkClient

type UserDefinedSinkServer added in v0.2.3 

type UserDefinedSinkServer interface {
	// SinkFn writes the Datum to a user defined sink.
	SinkFn(UserDefinedSink_SinkFnServer) error
	// IsReady is the heartbeat endpoint for gRPC.
	IsReady(context.Context, *emptypb.Empty) (*ReadyResponse, error)
	// contains filtered or unexported methods
}

UserDefinedSinkServer is the server API for UserDefinedSink service. All implementations must embed UnimplementedUserDefinedSinkServer for forward compatibility

type UserDefinedSink_SinkFnClient added in v0.2.5 

type UserDefinedSink_SinkFnClient interface {
	Send(*Datum) error
	CloseAndRecv() (*ResponseList, error)
	grpc.ClientStream
}

type UserDefinedSink_SinkFnServer added in v0.2.5 

type UserDefinedSink_SinkFnServer interface {
	SendAndClose(*ResponseList) error
	Recv() (*Datum, error)
	grpc.ServerStream
}

type Watermark added in v0.2.3 

type Watermark struct {

	// watermark is the monotonically increasing time which denotes completeness for the given time for the given vertex.
	// This watermark can be used to track completeness before persisting to sink.
	Watermark *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=watermark,proto3" json:"watermark,omitempty"`
	// contains filtered or unexported fields
}

func (*Watermark) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use Watermark.ProtoReflect.Descriptor instead.

func (*Watermark) GetWatermark added in v0.2.3 

func (x *Watermark) GetWatermark() *timestamppb.Timestamp

func (*Watermark) ProtoMessage added in v0.2.3 

func (*Watermark) ProtoMessage()

func (*Watermark) ProtoReflect added in v0.2.3 

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

func (*Watermark) Reset added in v0.2.3 

func (x *Watermark) Reset()

func (*Watermark) String added in v0.2.3 

func (x *Watermark) String() string

Source Files

View all Source files

Directories

Path Synopsis
Package sinkmock is a generated GoMock package.
 Package sinkmock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.