topictypes

Documentation

Index

• Constants
• type Codec
  • func (c Codec) ToRaw(r *rawtopiccommon.Codec)
• type Consumer
  • func (c *Consumer) FromRaw(raw *rawtopic.Consumer)
  • func (c *Consumer) ToRaw(raw *rawtopic.Consumer)
• type MeteringMode
  • func (m *MeteringMode) FromRaw(raw rawtopic.MeteringMode)
  • func (m *MeteringMode) ToRaw(raw *rawtopic.MeteringMode)
• type PartitionInfo
  • func (p *PartitionInfo) FromRaw(raw *rawtopic.PartitionInfo)
• type PartitionSettings
  • func (s *PartitionSettings) FromRaw(raw *rawtopic.PartitioningSettings)
  • func (s *PartitionSettings) ToRaw(raw *rawtopic.PartitioningSettings)
• type TopicDescription
  • func (d *TopicDescription) FromRaw(raw *rawtopic.DescribeTopicResult)

Constants

const (
	CodecRaw  = Codec(rawtopiccommon.CodecRaw)
	CodecGzip = Codec(rawtopiccommon.CodecGzip)

	// CodecLzop not supported by default, customer need provide own codec library
	CodecLzop = Codec(rawtopiccommon.CodecLzop)

	// CodecZstd not supported by default, customer need provide own codec library
	CodecZstd = Codec(rawtopiccommon.CodecZstd)

	CodecCustomerFirst = Codec(rawtopiccommon.CodecCustomerFirst)
	CodecCustomerEnd   = Codec(rawtopiccommon.CodecCustomerEnd) // last allowed custom codec id is CodecCustomerEnd-1
)

const (
	MeteringModeUnspecified      = MeteringMode(rawtopic.MeteringModeUnspecified)
	MeteringModeReservedCapacity = MeteringMode(rawtopic.MeteringModeReservedCapacity)
	MeteringModeRequestUnits     = MeteringMode(rawtopic.MeteringModeRequestUnits)
)

Types

type Codec

type Codec int32

Codec code for use in topics Allow to use custom values in interval [10000,20000)

func (Codec) ToRaw

func (c Codec) ToRaw(r *rawtopiccommon.Codec)

type Consumer

type Consumer struct {
	Name            string
	Important       bool
	SupportedCodecs []Codec
	ReadFrom        time.Time
	Attributes      map[string]string
}

Consumer contains info about topic consumer

func (*Consumer) FromRaw

func (c *Consumer) FromRaw(raw *rawtopic.Consumer)

FromRaw convert internal format to public. Used internally only.

func (*Consumer) ToRaw

func (c *Consumer) ToRaw(raw *rawtopic.Consumer)

ToRaw public format to internal. Used internally only.

type MeteringMode

type MeteringMode int

MeteringMode mode of topic's metering. Used for serverless installations.

func (*MeteringMode) FromRaw

func (m *MeteringMode) FromRaw(raw rawtopic.MeteringMode)

FromRaw convert from internal format to public. Used internally only.

func (*MeteringMode) ToRaw

func (m *MeteringMode) ToRaw(raw *rawtopic.MeteringMode)

ToRaw convert from public format to internal. Used internally only.

type PartitionInfo

type PartitionInfo struct {
	PartitionID        int64
	Active             bool
	ChildPartitionIDs  []int64
	ParentPartitionIDs []int64
}

PartitionInfo contains info about partition.

func (*PartitionInfo) FromRaw

func (p *PartitionInfo) FromRaw(raw *rawtopic.PartitionInfo)

FromRaw convert from internal format to public. Used internally only.

type PartitionSettings

type PartitionSettings struct {
	MinActivePartitions int64
	PartitionCountLimit int64
}

PartitionSettings settings of partitions

func (*PartitionSettings) FromRaw

func (s *PartitionSettings) FromRaw(raw *rawtopic.PartitioningSettings)

FromRaw convert internal format to public. Used internally only.

func (*PartitionSettings) ToRaw

func (s *PartitionSettings) ToRaw(raw *rawtopic.PartitioningSettings)

ToRaw convert public format to internal. Used internally only.

type TopicDescription

type TopicDescription struct {
	Path                              string
	PartitionSettings                 PartitionSettings
	Partitions                        []PartitionInfo
	RetentionPeriod                   time.Duration
	RetentionStorageMB                int64
	SupportedCodecs                   []Codec
	PartitionWriteBurstBytes          int64
	PartitionWriteSpeedBytesPerSecond int64
	Attributes                        map[string]string
	Consumers                         []Consumer
	MeteringMode                      MeteringMode
}

TopicDescription contains info about topic.

func (*TopicDescription) FromRaw

func (d *TopicDescription) FromRaw(raw *rawtopic.DescribeTopicResult)

FromRaw convert from public format to internal. Used internally only.