Documentation ¶
Index ¶
- type Error
- func (*Error) Descriptor() ([]byte, []int)
- func (m *Error) GetError() string
- func (m *Error) GetMetadata() map[string][]byte
- func (m *Error) GetOccurredAtUnixTsUtc() int64
- func (*Error) ProtoMessage()
- func (m *Error) Reset()
- func (m *Error) String() string
- func (m *Error) XXX_DiscardUnknown()
- func (m *Error) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Error) XXX_Merge(src proto.Message)
- func (m *Error) XXX_Size() int
- func (m *Error) XXX_Unmarshal(b []byte) error
- type IsRead_Record
- type Kafka
- func (*Kafka) Descriptor() ([]byte, []int)
- func (m *Kafka) GetHeaders() []*KafkaHeader
- func (m *Kafka) GetKey() []byte
- func (m *Kafka) GetOffset() int64
- func (m *Kafka) GetPartition() int32
- func (m *Kafka) GetTimestamp() int64
- func (m *Kafka) GetTopic() string
- func (m *Kafka) GetValue() []byte
- func (*Kafka) ProtoMessage()
- func (m *Kafka) Reset()
- func (m *Kafka) String() string
- func (m *Kafka) XXX_DiscardUnknown()
- func (m *Kafka) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Kafka) XXX_Merge(src proto.Message)
- func (m *Kafka) XXX_Size() int
- func (m *Kafka) XXX_Unmarshal(b []byte) error
- type KafkaHeader
- func (*KafkaHeader) Descriptor() ([]byte, []int)
- func (m *KafkaHeader) GetKey() string
- func (m *KafkaHeader) GetValue() string
- func (*KafkaHeader) ProtoMessage()
- func (m *KafkaHeader) Reset()
- func (m *KafkaHeader) String() string
- func (m *KafkaHeader) XXX_DiscardUnknown()
- func (m *KafkaHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *KafkaHeader) XXX_Merge(src proto.Message)
- func (m *KafkaHeader) XXX_Size() int
- func (m *KafkaHeader) XXX_Unmarshal(b []byte) error
- type Read
- func (*Read) Descriptor() ([]byte, []int)
- func (m *Read) GetKafka() *Kafka
- func (m *Read) GetMessageId() string
- func (m *Read) GetMetadata() map[string][]byte
- func (m *Read) GetPayload() []byte
- func (m *Read) GetPlumberId() string
- func (m *Read) GetRaw() []byte
- func (m *Read) GetReceivedAtUnixTsUtc() int64
- func (m *Read) GetRecord() isRead_Record
- func (*Read) ProtoMessage()
- func (m *Read) Reset()
- func (m *Read) String() string
- func (m *Read) XXX_DiscardUnknown()
- func (m *Read) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Read) XXX_Merge(src proto.Message)
- func (*Read) XXX_OneofWrappers() []interface{}
- func (m *Read) XXX_Size() int
- func (m *Read) XXX_Unmarshal(b []byte) error
- type Read_Kafka
- type Write
- func (*Write) Descriptor() ([]byte, []int)
- func (m *Write) GetInput() string
- func (m *Write) GetInputMetadata() map[string]string
- func (*Write) ProtoMessage()
- func (m *Write) Reset()
- func (m *Write) String() string
- func (m *Write) XXX_DiscardUnknown()
- func (m *Write) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Write) XXX_Merge(src proto.Message)
- func (m *Write) XXX_Size() int
- func (m *Write) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Error ¶ added in v0.0.49
type Error struct { OccurredAtUnixTsUtc int64 `protobuf:"varint,1,opt,name=occurred_at_unix_ts_utc,json=occurredAtUnixTsUtc,proto3" json:"occurred_at_unix_ts_utc,omitempty"` Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` Metadata map[string][]byte `` /* 157-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Used for communicating errors that occur during a read, write, relay, etc.
func (*Error) Descriptor ¶ added in v0.0.49
func (*Error) GetMetadata ¶ added in v0.0.49
func (*Error) GetOccurredAtUnixTsUtc ¶ added in v0.0.49
func (*Error) ProtoMessage ¶ added in v0.0.49
func (*Error) ProtoMessage()
func (*Error) XXX_DiscardUnknown ¶ added in v0.0.49
func (m *Error) XXX_DiscardUnknown()
func (*Error) XXX_Marshal ¶ added in v0.0.49
func (*Error) XXX_Unmarshal ¶ added in v0.0.49
type IsRead_Record ¶ added in v0.0.49
type IsRead_Record = isRead_Record
type Kafka ¶
type Kafka struct { Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"` Key []byte `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"` Value []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"` Timestamp int64 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` Offset int64 `protobuf:"varint,5,opt,name=offset,proto3" json:"offset,omitempty"` Partition int32 `protobuf:"varint,6,opt,name=partition,proto3" json:"partition,omitempty"` Headers []*KafkaHeader `protobuf:"bytes,7,rep,name=headers,proto3" json:"headers,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Kafka) Descriptor ¶
func (*Kafka) GetHeaders ¶
func (m *Kafka) GetHeaders() []*KafkaHeader
func (*Kafka) GetPartition ¶
func (*Kafka) GetTimestamp ¶
func (*Kafka) ProtoMessage ¶
func (*Kafka) ProtoMessage()
func (*Kafka) XXX_DiscardUnknown ¶
func (m *Kafka) XXX_DiscardUnknown()
func (*Kafka) XXX_Marshal ¶
func (*Kafka) XXX_Unmarshal ¶
type KafkaHeader ¶
type KafkaHeader struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*KafkaHeader) Descriptor ¶
func (*KafkaHeader) Descriptor() ([]byte, []int)
func (*KafkaHeader) GetKey ¶
func (m *KafkaHeader) GetKey() string
func (*KafkaHeader) GetValue ¶
func (m *KafkaHeader) GetValue() string
func (*KafkaHeader) ProtoMessage ¶
func (*KafkaHeader) ProtoMessage()
func (*KafkaHeader) Reset ¶
func (m *KafkaHeader) Reset()
func (*KafkaHeader) String ¶
func (m *KafkaHeader) String() string
func (*KafkaHeader) XXX_DiscardUnknown ¶
func (m *KafkaHeader) XXX_DiscardUnknown()
func (*KafkaHeader) XXX_Marshal ¶
func (m *KafkaHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*KafkaHeader) XXX_Merge ¶
func (m *KafkaHeader) XXX_Merge(src proto.Message)
func (*KafkaHeader) XXX_Size ¶
func (m *KafkaHeader) XXX_Size() int
func (*KafkaHeader) XXX_Unmarshal ¶
func (m *KafkaHeader) XXX_Unmarshal(b []byte) error
type Read ¶ added in v0.0.49
type Read struct { // Unique id automatically created by plumber MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"` // Identifies which plumber instance received the event PlumberId string `protobuf:"bytes,2,opt,name=plumber_id,json=plumberId,proto3" json:"plumber_id,omitempty"` // Metadata may contain properties that cannot be found in the Raw message. // For example: read lag in Kafka. // // Metadata may also contain data such as "count" which is an incremental // number that plumber assigns to each message it receives. This is used // with read via CLI functionality to allow the user to quickly discern // whether this is message #1 or #500, etc. Metadata map[string][]byte `` /* 157-byte string literal not displayed */ // Original backend message (encoded with gob, ie. *skafka.Message, etc.) Raw []byte `protobuf:"bytes,4,opt,name=raw,proto3" json:"raw,omitempty"` // UTC unix timestamp of when plumber received the message (a backend record // entry might have its own timestamp as well). ReceivedAtUnixTsUtc int64 `protobuf:"varint,5,opt,name=received_at_unix_ts_utc,json=receivedAtUnixTsUtc,proto3" json:"received_at_unix_ts_utc,omitempty"` // Set _outside_ the backend; will contain the final value, regardless of // whether decoding options were specified for a read. // _This_ is what both CLI and desktop should display for the payload. Payload []byte `protobuf:"bytes,99,opt,name=payload,proto3" json:"payload,omitempty"` // Types that are valid to be assigned to Record: // *Read_Kafka Record isRead_Record `protobuf_oneof:"Record"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Returned for read requests (server & cli)
func (*Read) Descriptor ¶ added in v0.0.49
func (*Read) GetMessageId ¶ added in v0.0.49
func (*Read) GetMetadata ¶ added in v0.0.49
func (*Read) GetPayload ¶ added in v0.0.49
func (*Read) GetPlumberId ¶ added in v0.0.49
func (*Read) GetReceivedAtUnixTsUtc ¶ added in v0.0.49
func (*Read) ProtoMessage ¶ added in v0.0.49
func (*Read) ProtoMessage()
func (*Read) XXX_DiscardUnknown ¶ added in v0.0.49
func (m *Read) XXX_DiscardUnknown()
func (*Read) XXX_Marshal ¶ added in v0.0.49
func (*Read) XXX_OneofWrappers ¶ added in v0.0.49
func (*Read) XXX_OneofWrappers() []interface{}
XXX_OneofWrappers is for the internal use of the proto package.
func (*Read) XXX_Unmarshal ¶ added in v0.0.49
type Read_Kafka ¶ added in v0.0.49
type Read_Kafka struct {
Kafka *Kafka `protobuf:"bytes,100,opt,name=kafka,proto3,oneof"`
}
type Write ¶ added in v0.0.49
type Write struct { // If encoding options are provided, this value will be updated by plumber // to contain the encoded payload _before_ passing it to the backend. // @gotags: kong:"help='Input string',name=input,xor=input,default" Input string `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty" kong:"help='Input string',name=input,xor=input,default"` // @gotags: kong:"help='Optional metadata a backend may use (key1:value,key2:value,etc)',name=input-metadata" InputMetadata map[string]string `` /* 286-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Used as an arg for write requests (server & cli)
func (*Write) Descriptor ¶ added in v0.0.49
func (*Write) GetInputMetadata ¶ added in v0.0.49
func (*Write) ProtoMessage ¶ added in v0.0.49
func (*Write) ProtoMessage()
func (*Write) XXX_DiscardUnknown ¶ added in v0.0.49
func (m *Write) XXX_DiscardUnknown()
func (*Write) XXX_Marshal ¶ added in v0.0.49
func (*Write) XXX_Unmarshal ¶ added in v0.0.49
Click to show internal directories.
Click to hide internal directories.