records

package
v0.0.74 Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2021 License: Apache-2.0 Imports: 3 Imported by: 31

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrorRecord added in v0.0.35

type ErrorRecord 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 (*ErrorRecord) Descriptor added in v0.0.35

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

func (*ErrorRecord) GetError added in v0.0.35

func (m *ErrorRecord) GetError() string

func (*ErrorRecord) GetMetadata added in v0.0.35

func (m *ErrorRecord) GetMetadata() map[string][]byte

func (*ErrorRecord) GetOccurredAtUnixTsUtc added in v0.0.35

func (m *ErrorRecord) GetOccurredAtUnixTsUtc() int64

func (*ErrorRecord) ProtoMessage added in v0.0.35

func (*ErrorRecord) ProtoMessage()

func (*ErrorRecord) Reset added in v0.0.35

func (m *ErrorRecord) Reset()

func (*ErrorRecord) String added in v0.0.35

func (m *ErrorRecord) String() string

func (*ErrorRecord) XXX_DiscardUnknown added in v0.0.35

func (m *ErrorRecord) XXX_DiscardUnknown()

func (*ErrorRecord) XXX_Marshal added in v0.0.35

func (m *ErrorRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ErrorRecord) XXX_Merge added in v0.0.35

func (m *ErrorRecord) XXX_Merge(src proto.Message)

func (*ErrorRecord) XXX_Size added in v0.0.35

func (m *ErrorRecord) XXX_Size() int

func (*ErrorRecord) XXX_Unmarshal added in v0.0.35

func (m *ErrorRecord) XXX_Unmarshal(b []byte) error

type IsReadRecord_Record added in v0.0.51

type IsReadRecord_Record = isReadRecord_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) Descriptor() ([]byte, []int)

func (*Kafka) GetHeaders

func (m *Kafka) GetHeaders() []*KafkaHeader

func (*Kafka) GetKey

func (m *Kafka) GetKey() []byte

func (*Kafka) GetOffset

func (m *Kafka) GetOffset() int64

func (*Kafka) GetPartition

func (m *Kafka) GetPartition() int32

func (*Kafka) GetTimestamp

func (m *Kafka) GetTimestamp() int64

func (*Kafka) GetTopic

func (m *Kafka) GetTopic() string

func (*Kafka) GetValue

func (m *Kafka) GetValue() []byte

func (*Kafka) ProtoMessage

func (*Kafka) ProtoMessage()

func (*Kafka) Reset

func (m *Kafka) Reset()

func (*Kafka) String

func (m *Kafka) String() string

func (*Kafka) XXX_DiscardUnknown

func (m *Kafka) XXX_DiscardUnknown()

func (*Kafka) XXX_Marshal

func (m *Kafka) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Kafka) XXX_Merge

func (m *Kafka) XXX_Merge(src proto.Message)

func (*Kafka) XXX_Size

func (m *Kafka) XXX_Size() int

func (*Kafka) XXX_Unmarshal

func (m *Kafka) XXX_Unmarshal(b []byte) error

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

type ReadRecord struct {
	// Unique id automatically created by plumber
	MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// Plumber counts the number of messages it reads; this number represents
	// the message number (useful for CLI).
	Num int64 `protobuf:"varint,3,opt,name=num,proto3" json:"num,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]string `` /* 157-byte string literal not displayed */
	// UTC unix timestamp of when plumber received the message; a backend record
	// entry might have its own timestamp as well. This should be seconds.
	ReceivedAtUnixTsUtc int64 `protobuf:"varint,6,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:
	//	*ReadRecord_Kafka
	Record isReadRecord_Record `protobuf_oneof:"Record"`
	// Original backend message (encoded with gob, ie. *skafka.Message, etc.).
	// In most cases, you should use the oneof record instead of the raw message.
	XRaw []byte `protobuf:"bytes,1000,opt,name=_raw,json=Raw,proto3" json:"_raw,omitempty"`
	// Identifies which plumber instance received the event (set outside the backend)
	XPlumberId           string   `protobuf:"bytes,1001,opt,name=_plumber_id,json=PlumberId,proto3" json:"_plumber_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Returned for read requests (server & cli)

func (*ReadRecord) Descriptor added in v0.0.34

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

func (*ReadRecord) GetKafka added in v0.0.34

func (m *ReadRecord) GetKafka() *Kafka

func (*ReadRecord) GetMessageId added in v0.0.34

func (m *ReadRecord) GetMessageId() string

func (*ReadRecord) GetMetadata added in v0.0.34

func (m *ReadRecord) GetMetadata() map[string]string

func (*ReadRecord) GetNum added in v0.0.51

func (m *ReadRecord) GetNum() int64

func (*ReadRecord) GetPayload added in v0.0.51

func (m *ReadRecord) GetPayload() []byte

func (*ReadRecord) GetReceivedAtUnixTsUtc added in v0.0.35

func (m *ReadRecord) GetReceivedAtUnixTsUtc() int64

func (*ReadRecord) GetRecord added in v0.0.34

func (m *ReadRecord) GetRecord() isReadRecord_Record

func (*ReadRecord) GetXPlumberId added in v0.0.51

func (m *ReadRecord) GetXPlumberId() string

func (*ReadRecord) GetXRaw added in v0.0.51

func (m *ReadRecord) GetXRaw() []byte

func (*ReadRecord) ProtoMessage added in v0.0.34

func (*ReadRecord) ProtoMessage()

func (*ReadRecord) Reset added in v0.0.34

func (m *ReadRecord) Reset()

func (*ReadRecord) String added in v0.0.34

func (m *ReadRecord) String() string

func (*ReadRecord) XXX_DiscardUnknown added in v0.0.34

func (m *ReadRecord) XXX_DiscardUnknown()

func (*ReadRecord) XXX_Marshal added in v0.0.34

func (m *ReadRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ReadRecord) XXX_Merge added in v0.0.34

func (m *ReadRecord) XXX_Merge(src proto.Message)

func (*ReadRecord) XXX_OneofWrappers added in v0.0.34

func (*ReadRecord) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ReadRecord) XXX_Size added in v0.0.34

func (m *ReadRecord) XXX_Size() int

func (*ReadRecord) XXX_Unmarshal added in v0.0.34

func (m *ReadRecord) XXX_Unmarshal(b []byte) error

type ReadRecord_Kafka added in v0.0.34

type ReadRecord_Kafka struct {
	Kafka *Kafka `protobuf:"bytes,100,opt,name=kafka,proto3,oneof"`
}

type WriteRecord added in v0.0.34

type WriteRecord 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 (*WriteRecord) Descriptor added in v0.0.34

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

func (*WriteRecord) GetInput added in v0.0.46

func (m *WriteRecord) GetInput() string

func (*WriteRecord) GetInputMetadata added in v0.0.46

func (m *WriteRecord) GetInputMetadata() map[string]string

func (*WriteRecord) ProtoMessage added in v0.0.34

func (*WriteRecord) ProtoMessage()

func (*WriteRecord) Reset added in v0.0.34

func (m *WriteRecord) Reset()

func (*WriteRecord) String added in v0.0.34

func (m *WriteRecord) String() string

func (*WriteRecord) XXX_DiscardUnknown added in v0.0.34

func (m *WriteRecord) XXX_DiscardUnknown()

func (*WriteRecord) XXX_Marshal added in v0.0.34

func (m *WriteRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteRecord) XXX_Merge added in v0.0.34

func (m *WriteRecord) XXX_Merge(src proto.Message)

func (*WriteRecord) XXX_Size added in v0.0.34

func (m *WriteRecord) XXX_Size() int

func (*WriteRecord) XXX_Unmarshal added in v0.0.34

func (m *WriteRecord) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL