topictypes

package
v3.116.2 Latest Latest
Warning

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

 Go to latest Published: Sep 25, 2025 License: Apache-2.0 Imports: 6 Imported by: 7

Documentation

Index

Constants

View Source 
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
)
View Source 
const (
	MeteringModeUnspecified      = MeteringMode(rawtopic.MeteringModeUnspecified)
	MeteringModeReservedCapacity = MeteringMode(rawtopic.MeteringModeReservedCapacity)
	MeteringModeRequestUnits     = MeteringMode(rawtopic.MeteringModeRequestUnits)
)
View Source 
const (
	AutoPartitioningStrategyUnspecified    = AutoPartitioningStrategy(rawtopic.AutoPartitioningStrategyUnspecified)
	AutoPartitioningStrategyDisabled       = AutoPartitioningStrategy(rawtopic.AutoPartitioningStrategyDisabled)
	AutoPartitioningStrategyScaleUp        = AutoPartitioningStrategy(rawtopic.AutoPartitioningStrategyScaleUp)
	AutoPartitioningStrategyScaleUpAndDown = AutoPartitioningStrategy(rawtopic.AutoPartitioningStrategyScaleUpAndDown)
	AutoPartitioningStrategyPaused         = AutoPartitioningStrategy(rawtopic.AutoPartitioningStrategyPaused)
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoPartitioningSettings added in v3.109.0 

type AutoPartitioningSettings struct {
	AutoPartitioningStrategy           AutoPartitioningStrategy
	AutoPartitioningWriteSpeedStrategy AutoPartitioningWriteSpeedStrategy
}

AutoPartitioningSettings contains settings for automatic partitioning

func (*AutoPartitioningSettings) FromRaw added in v3.109.0 

func (s *AutoPartitioningSettings) FromRaw(raw *rawtopic.AutoPartitioningSettings)

FromRaw convert internal format to public. Used internally only.

func (*AutoPartitioningSettings) ToRaw added in v3.109.0 

func (s *AutoPartitioningSettings) ToRaw(raw *rawtopic.AutoPartitioningSettings)

ToRaw convert public format to internal. Used internally only.

type AutoPartitioningStrategy added in v3.109.0 

type AutoPartitioningStrategy int32

AutoPartitioningStrategy defines the strategy for automatic partitioning

type AutoPartitioningWriteSpeedStrategy added in v3.109.0 

type AutoPartitioningWriteSpeedStrategy struct {
	StabilizationWindow    time.Duration
	UpUtilizationPercent   int32
	DownUtilizationPercent int32
}

AutoPartitioningWriteSpeedStrategy contains settings for write speed strategy

func (*AutoPartitioningWriteSpeedStrategy) FromRaw added in v3.109.0 

func (s *AutoPartitioningWriteSpeedStrategy) FromRaw(raw *rawtopic.AutoPartitioningWriteSpeedStrategy)

FromRaw convert internal format to public. Used internally only.

func (*AutoPartitioningWriteSpeedStrategy) ToRaw added in v3.109.0 

func (s *AutoPartitioningWriteSpeedStrategy) ToRaw() rawtopic.AutoPartitioningWriteSpeedStrategy

ToRaw convert public format to internal. Used internally only.

type Codec 

type Codec int32

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

func (Codec) ToRaw added in v3.38.2 

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 added in v3.35.0 

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 DescribeConsumerPartitionInfo added in v3.85.0 

type DescribeConsumerPartitionInfo struct {
	PartitionID            int64
	Active                 bool
	ChildPartitionIDs      []int64
	ParentPartitionIDs     []int64
	PartitionStats         PartitionStats
	PartitionConsumerStats PartitionConsumerStats
}

func (*DescribeConsumerPartitionInfo) FromRaw added in v3.85.0 

func (p *DescribeConsumerPartitionInfo) FromRaw(raw *rawtopic.DescribeConsumerResultPartitionInfo)

type MeteringMode added in v3.38.2 

type MeteringMode int

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

func (*MeteringMode) FromRaw added in v3.38.2 

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

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

func (*MeteringMode) ToRaw added in v3.38.2 

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

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

type MultipleWindowsStat added in v3.85.0 

type MultipleWindowsStat struct {
	PerMinute int64
	PerHour   int64
	PerDay    int64
}

func (*MultipleWindowsStat) FromRaw added in v3.85.0 

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

type OffsetRange added in v3.85.0 

type OffsetRange topiclistenerinternal.PublicOffsetsRange

type PartitionConsumerStats added in v3.85.0 

type PartitionConsumerStats struct {
	LastReadOffset                 int64
	CommittedOffset                int64
	ReadSessionID                  string
	PartitionReadSessionCreateTime *time.Time
	LastReadTime                   *time.Time
	MaxReadTimeLag                 *time.Duration
	MaxWriteTimeLag                *time.Duration
	BytesRead                      MultipleWindowsStat
	ReaderName                     string
}

func (*PartitionConsumerStats) FromRaw added in v3.85.0 

func (s *PartitionConsumerStats) FromRaw(raw *rawtopic.PartitionConsumerStats)

type PartitionInfo added in v3.38.2 

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

PartitionInfo contains info about partition.

func (*PartitionInfo) FromRaw added in v3.38.2 

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

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

type PartitionSettings 

type PartitionSettings struct {
	MinActivePartitions      int64
	MaxActivePartitions      int64
	PartitionCountLimit      int64
	AutoPartitioningSettings AutoPartitioningSettings
}

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 PartitionStats added in v3.85.0 

type PartitionStats struct {
	PartitionsOffset OffsetRange
	StoreSizeBytes   int64
	LastWriteTime    *time.Time
	MaxWriteTimeLag  *time.Duration
	BytesWritten     MultipleWindowsStat
}

func (*PartitionStats) FromRaw added in v3.85.0 

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

type TopicConsumerDescription added in v3.85.0 

type TopicConsumerDescription struct {
	Path       string
	Consumer   Consumer
	Partitions []DescribeConsumerPartitionInfo
}

func (*TopicConsumerDescription) FromRaw added in v3.85.0 

func (d *TopicConsumerDescription) FromRaw(raw *rawtopic.DescribeConsumerResult)

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.

Source Files

View all Source files

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.