Documentation
¶
Index ¶
- Variables
- type Body
- type Header
- func (*Header) Descriptor() ([]byte, []int)deprecated
- func (x *Header) GetHeaders() map[string]string
- func (x *Header) GetId() *MessageID
- func (x *Header) GetKeys() []string
- func (x *Header) GetKind() MessageKind
- func (x *Header) GetMessageInfo() *MessageInfo
- func (x *Header) GetMetadata() *proto.Metadata
- func (*Header) ProtoMessage()
- func (x *Header) ProtoReflect() protoreflect.Message
- func (x *Header) Reset()
- func (x *Header) String() string
- type Message
- type MessageID
- func (*MessageID) Descriptor() ([]byte, []int)deprecated
- func (x *MessageID) GetIndex() int32
- func (x *MessageID) GetOffset() string
- func (x *MessageID) GetVertexName() string
- func (*MessageID) ProtoMessage()
- func (x *MessageID) ProtoReflect() protoreflect.Message
- func (x *MessageID) Reset()
- func (x *MessageID) String() string
- type MessageInfo
- func (*MessageInfo) Descriptor() ([]byte, []int)deprecated
- func (x *MessageInfo) GetEventTime() *timestamppb.Timestamp
- func (x *MessageInfo) GetIsLate() bool
- func (*MessageInfo) ProtoMessage()
- func (x *MessageInfo) ProtoReflect() protoreflect.Message
- func (x *MessageInfo) Reset()
- func (x *MessageInfo) String() string
- type MessageKind
- func (MessageKind) Descriptor() protoreflect.EnumDescriptor
- func (x MessageKind) Enum() *MessageKind
- func (MessageKind) EnumDescriptor() ([]byte, []int)deprecated
- func (x MessageKind) Number() protoreflect.EnumNumber
- func (x MessageKind) String() string
- func (MessageKind) Type() protoreflect.EnumType
- type MessageMetadata
- type ReadMessage
- func (*ReadMessage) Descriptor() ([]byte, []int)deprecated
- func (x *ReadMessage) GetMessage() *Message
- func (x *ReadMessage) GetMetadata() *MessageMetadata
- func (x *ReadMessage) GetReadOffset() int64
- func (x *ReadMessage) GetWatermark() *timestamppb.Timestamp
- func (*ReadMessage) ProtoMessage()
- func (x *ReadMessage) ProtoReflect() protoreflect.Message
- func (x *ReadMessage) Reset()
- func (x *ReadMessage) String() string
- type WriteMessage
- func (*WriteMessage) Descriptor() ([]byte, []int)deprecated
- func (x *WriteMessage) GetMessage() *Message
- func (x *WriteMessage) GetTags() []string
- func (*WriteMessage) ProtoMessage()
- func (x *WriteMessage) ProtoReflect() protoreflect.Message
- func (x *WriteMessage) Reset()
- func (x *WriteMessage) String() string
Constants ¶
This section is empty.
Variables ¶
var ( MessageKind_name = map[int32]string{ 0: "DATA", 1: "WMB", } MessageKind_value = map[string]int32{ "DATA": 0, "WMB": 1, } )
Enum value maps for MessageKind.
var File_pkg_apis_proto_isb_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Body ¶
type Body struct {
// Payload is the actual data of the message
Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
Body is the body of the message
func (*Body) Descriptor
deprecated
func (*Body) GetPayload ¶
func (*Body) ProtoMessage ¶
func (*Body) ProtoMessage()
func (*Body) ProtoReflect ¶
func (x *Body) ProtoReflect() protoreflect.Message
type Header ¶
type Header struct {
// MessageInfo contains the information window of the payload.
MessageInfo *MessageInfo `protobuf:"bytes,1,opt,name=message_info,json=messageInfo,proto3" json:"message_info,omitempty"`
// Kind indicates the kind of Message
Kind MessageKind `protobuf:"varint,2,opt,name=kind,proto3,enum=isb.MessageKind" json:"kind,omitempty"`
// ID is used for exactly-once-semantics. ID is a combination of vertex name, offset and index of the message.
Id *MessageID `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
// Keys is (key,value) in the map-reduce paradigm will be used for reduce operation
Keys []string `protobuf:"bytes,4,rep,name=keys,proto3" json:"keys,omitempty"`
// Headers is the headers of the message which can be used to store and propagate source headers
Headers map[string]string `` /* 141-byte string literal not displayed */
// Metadata is the metadata of the message
Metadata *proto.Metadata `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
Header is the header of the message
func (*Header) Descriptor
deprecated
func (*Header) GetHeaders ¶
func (*Header) GetKind ¶
func (x *Header) GetKind() MessageKind
func (*Header) GetMessageInfo ¶
func (x *Header) GetMessageInfo() *MessageInfo
func (*Header) GetMetadata ¶ added in v1.6.0
func (*Header) ProtoMessage ¶
func (*Header) ProtoMessage()
func (*Header) ProtoReflect ¶
func (x *Header) ProtoReflect() protoreflect.Message
type Message ¶
type Message struct {
Header *Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
Body *Body `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
// contains filtered or unexported fields
}
Message is inter step message
func (*Message) Descriptor
deprecated
func (*Message) ProtoMessage ¶
func (*Message) ProtoMessage()
func (*Message) ProtoReflect ¶
func (x *Message) ProtoReflect() protoreflect.Message
type MessageID ¶
type MessageID struct {
// VertexName is the name of the vertex
VertexName string `protobuf:"bytes,1,opt,name=vertex_name,json=vertexName,proto3" json:"vertex_name,omitempty"`
// Offset is the offset of the message
Offset string `protobuf:"bytes,2,opt,name=offset,proto3" json:"offset,omitempty"`
// Index is the index of a flatmap message.
Index int32 `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
// contains filtered or unexported fields
}
MessageID is the message ID of the message which is used for exactly-once-semantics.
func (*MessageID) Descriptor
deprecated
func (*MessageID) GetVertexName ¶
func (*MessageID) ProtoMessage ¶
func (*MessageID) ProtoMessage()
func (*MessageID) ProtoReflect ¶
func (x *MessageID) ProtoReflect() protoreflect.Message
type MessageInfo ¶
type MessageInfo struct {
// EventTime represents the event time of the message
EventTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
// IsLate is used to indicate if the message is a late data
IsLate bool `protobuf:"varint,2,opt,name=is_late,json=isLate,proto3" json:"is_late,omitempty"`
// contains filtered or unexported fields
}
MessageInfo is the message information window of the payload.
func (*MessageInfo) Descriptor
deprecated
func (*MessageInfo) Descriptor() ([]byte, []int)
Deprecated: Use MessageInfo.ProtoReflect.Descriptor instead.
func (*MessageInfo) GetEventTime ¶
func (x *MessageInfo) GetEventTime() *timestamppb.Timestamp
func (*MessageInfo) GetIsLate ¶
func (x *MessageInfo) GetIsLate() bool
func (*MessageInfo) ProtoMessage ¶
func (*MessageInfo) ProtoMessage()
func (*MessageInfo) ProtoReflect ¶
func (x *MessageInfo) ProtoReflect() protoreflect.Message
func (*MessageInfo) Reset ¶
func (x *MessageInfo) Reset()
func (*MessageInfo) String ¶
func (x *MessageInfo) String() string
type MessageKind ¶
type MessageKind int32
MessageKind represents the message type of the payload.
const ( MessageKind_DATA MessageKind = 0 // Data payload MessageKind_WMB MessageKind = 1 // Watermark Barrier )
func (MessageKind) Descriptor ¶
func (MessageKind) Descriptor() protoreflect.EnumDescriptor
func (MessageKind) Enum ¶
func (x MessageKind) Enum() *MessageKind
func (MessageKind) EnumDescriptor
deprecated
func (MessageKind) EnumDescriptor() ([]byte, []int)
Deprecated: Use MessageKind.Descriptor instead.
func (MessageKind) Number ¶
func (x MessageKind) Number() protoreflect.EnumNumber
func (MessageKind) String ¶
func (x MessageKind) String() string
func (MessageKind) Type ¶
func (MessageKind) Type() protoreflect.EnumType
type MessageMetadata ¶
type MessageMetadata struct {
// NumDelivered is the number of times the message has been delivered.
NumDelivered uint64 `protobuf:"varint,1,opt,name=num_delivered,json=numDelivered,proto3" json:"num_delivered,omitempty"`
// contains filtered or unexported fields
}
MessageMetadata is the metadata of the message
func (*MessageMetadata) Descriptor
deprecated
func (*MessageMetadata) Descriptor() ([]byte, []int)
Deprecated: Use MessageMetadata.ProtoReflect.Descriptor instead.
func (*MessageMetadata) GetNumDelivered ¶
func (x *MessageMetadata) GetNumDelivered() uint64
func (*MessageMetadata) ProtoMessage ¶
func (*MessageMetadata) ProtoMessage()
func (*MessageMetadata) ProtoReflect ¶
func (x *MessageMetadata) ProtoReflect() protoreflect.Message
func (*MessageMetadata) Reset ¶
func (x *MessageMetadata) Reset()
func (*MessageMetadata) String ¶
func (x *MessageMetadata) String() string
type ReadMessage ¶
type ReadMessage struct {
// Message is the actual message read from the buffer
Message *Message `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// ReadOffset is the offset at which the message was read
ReadOffset int64 `protobuf:"varint,2,opt,name=read_offset,json=readOffset,proto3" json:"read_offset,omitempty"`
// Watermark is the watermark timestamp
Watermark *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=watermark,proto3" json:"watermark,omitempty"`
// Metadata is the metadata of the message after a message is read from the buffer.
Metadata *MessageMetadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
ReadMessage is the message read from the buffer.
func (*ReadMessage) Descriptor
deprecated
func (*ReadMessage) Descriptor() ([]byte, []int)
Deprecated: Use ReadMessage.ProtoReflect.Descriptor instead.
func (*ReadMessage) GetMessage ¶
func (x *ReadMessage) GetMessage() *Message
func (*ReadMessage) GetMetadata ¶
func (x *ReadMessage) GetMetadata() *MessageMetadata
func (*ReadMessage) GetReadOffset ¶
func (x *ReadMessage) GetReadOffset() int64
func (*ReadMessage) GetWatermark ¶
func (x *ReadMessage) GetWatermark() *timestamppb.Timestamp
func (*ReadMessage) ProtoMessage ¶
func (*ReadMessage) ProtoMessage()
func (*ReadMessage) ProtoReflect ¶
func (x *ReadMessage) ProtoReflect() protoreflect.Message
func (*ReadMessage) Reset ¶
func (x *ReadMessage) Reset()
func (*ReadMessage) String ¶
func (x *ReadMessage) String() string
type WriteMessage ¶
type WriteMessage struct {
// Message is the actual message to be written
Message *Message `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// Tags are the tags associated with the message
Tags []string `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"`
// contains filtered or unexported fields
}
WriteMessage is a wrapper for an isb message with tag information which will be used for conditional forwarding.
func (*WriteMessage) Descriptor
deprecated
func (*WriteMessage) Descriptor() ([]byte, []int)
Deprecated: Use WriteMessage.ProtoReflect.Descriptor instead.
func (*WriteMessage) GetMessage ¶
func (x *WriteMessage) GetMessage() *Message
func (*WriteMessage) GetTags ¶
func (x *WriteMessage) GetTags() []string
func (*WriteMessage) ProtoMessage ¶
func (*WriteMessage) ProtoMessage()
func (*WriteMessage) ProtoReflect ¶
func (x *WriteMessage) ProtoReflect() protoreflect.Message
func (*WriteMessage) Reset ¶
func (x *WriteMessage) Reset()
func (*WriteMessage) String ¶
func (x *WriteMessage) String() string