 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- type AlterAutoPartitioningSettings
- type AlterAutoPartitioningWriteSpeedStrategy
- type AlterConsumer
- type AlterPartitioningSettings
- type AlterTopicRequest
- type AlterTopicResult
- type AutoPartitioningSettings
- type AutoPartitioningStrategy
- type AutoPartitioningWriteSpeedStrategy
- type Client
- func (c *Client) AlterTopic(ctx context.Context, req *AlterTopicRequest) (res AlterTopicResult, err error)
- func (c *Client) CreateTopic(ctx context.Context, req *CreateTopicRequest) (res CreateTopicResult, err error)
- func (c *Client) DescribeConsumer(ctx context.Context, req DescribeConsumerRequest) (res DescribeConsumerResult, err error)
- func (c *Client) DescribeTopic(ctx context.Context, req DescribeTopicRequest) (res DescribeTopicResult, err error)
- func (c *Client) DropTopic(ctx context.Context, req DropTopicRequest) (res DropTopicResult, err error)
- func (c *Client) StreamRead(ctxStreamLifeTime context.Context, readerID int64, tracer *trace.Topic) (rawtopicreader.StreamReader, error)
- func (c *Client) StreamWrite(ctxStreamLifeTime context.Context, tracer *trace.Topic) (*rawtopicwriter.StreamWriter, error)
- func (c *Client) UpdateOffsetsInTransaction(ctx context.Context, req *UpdateOffsetsInTransactionRequest) error
 
- type Consumer
- type CreateTopicRequest
- type CreateTopicResult
- type DescribeConsumerRequest
- type DescribeConsumerResult
- type DescribeConsumerResultPartitionInfo
- type DescribeTopicRequest
- type DescribeTopicResult
- type DropTopicRequest
- type DropTopicResult
- type MeteringMode
- type MultipleWindowsStat
- type PartitionConsumerStats
- type PartitionInfo
- type PartitionStats
- type PartitioningSettings
- type UpdateOffsetsInTransactionRequest
- type UpdateOffsetsInTransactionRequest_PartitionOffsets
- type UpdateOffsetsInTransactionRequest_TopicOffsets
Constants ¶
      View Source
      
  
    const ( MeteringModeUnspecified = MeteringMode(Ydb_Topic.MeteringMode_METERING_MODE_UNSPECIFIED) MeteringModeReservedCapacity = MeteringMode(Ydb_Topic.MeteringMode_METERING_MODE_RESERVED_CAPACITY) MeteringModeRequestUnits = MeteringMode(Ydb_Topic.MeteringMode_METERING_MODE_REQUEST_UNITS) )
      View Source
      
  
const ( AutoPartitioningStrategyUnspecified = AutoPartitioningStrategy(Ydb_Topic.AutoPartitioningStrategy_AUTO_PARTITIONING_STRATEGY_UNSPECIFIED) //nolint:lll AutoPartitioningStrategyDisabled = AutoPartitioningStrategy(Ydb_Topic.AutoPartitioningStrategy_AUTO_PARTITIONING_STRATEGY_DISABLED) //nolint:lll AutoPartitioningStrategyScaleUp = AutoPartitioningStrategy(Ydb_Topic.AutoPartitioningStrategy_AUTO_PARTITIONING_STRATEGY_SCALE_UP) //nolint:lll AutoPartitioningStrategyScaleUpAndDown = AutoPartitioningStrategy(Ydb_Topic.AutoPartitioningStrategy_AUTO_PARTITIONING_STRATEGY_SCALE_UP_AND_DOWN) //nolint:lll AutoPartitioningStrategyPaused = AutoPartitioningStrategy(Ydb_Topic.AutoPartitioningStrategy_AUTO_PARTITIONING_STRATEGY_PAUSED) //nolint:lll )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlterAutoPartitioningSettings ¶ added in v3.109.0
type AlterAutoPartitioningSettings struct {
	SetStrategy            AutoPartitioningStrategy
	SetPartitionWriteSpeed *AlterAutoPartitioningWriteSpeedStrategy
}
    func (*AlterAutoPartitioningSettings) ToProto ¶ added in v3.109.0
func (s *AlterAutoPartitioningSettings) ToProto() *Ydb_Topic.AlterAutoPartitioningSettings
type AlterAutoPartitioningWriteSpeedStrategy ¶ added in v3.109.0
type AlterAutoPartitioningWriteSpeedStrategy struct {
	SetStabilizationWindow    rawoptional.Duration
	SetUpUtilizationPercent   rawoptional.Int32
	SetDownUtilizationPercent rawoptional.Int32
}
    func (*AlterAutoPartitioningWriteSpeedStrategy) ToProto ¶ added in v3.109.0
func (s *AlterAutoPartitioningWriteSpeedStrategy) ToProto() *Ydb_Topic.AlterAutoPartitioningWriteSpeedStrategy
type AlterConsumer ¶
type AlterConsumer struct {
	Name               string
	SetImportant       rawoptional.Bool
	SetReadFrom        rawoptional.Time
	SetSupportedCodecs rawtopiccommon.SupportedCodecs
	AlterAttributes    map[string]string
}
    func (*AlterConsumer) ToProto ¶
func (c *AlterConsumer) ToProto() *Ydb_Topic.AlterConsumer
type AlterPartitioningSettings ¶
type AlterPartitioningSettings struct {
	SetMinActivePartitions        rawoptional.Int64
	SetMaxActivePartitions        rawoptional.Int64
	SetPartitionCountLimit        rawoptional.Int64
	AlterAutoPartitioningSettings *AlterAutoPartitioningSettings
}
    func (*AlterPartitioningSettings) ToProto ¶
func (s *AlterPartitioningSettings) ToProto() *Ydb_Topic.AlterPartitioningSettings
type AlterTopicRequest ¶
type AlterTopicRequest struct {
	OperationParams rawydb.OperationParams
	Path string
	AlterPartitionSettings               AlterPartitioningSettings
	SetRetentionPeriod                   rawoptional.Duration
	SetRetentionStorageMB                rawoptional.Int64
	SetSupportedCodecs                   bool
	SetSupportedCodecsValue              rawtopiccommon.SupportedCodecs
	SetPartitionWriteSpeedBytesPerSecond rawoptional.Int64
	SetPartitionWriteBurstBytes          rawoptional.Int64
	AlterAttributes                      map[string]string
	AddConsumers                         []Consumer
	DropConsumers                        []string
	AlterConsumers                       []AlterConsumer
	SetMeteringMode                      MeteringMode
}
    func (*AlterTopicRequest) ToProto ¶
func (req *AlterTopicRequest) ToProto() *Ydb_Topic.AlterTopicRequest
type AlterTopicResult ¶
func (*AlterTopicResult) FromProto ¶
func (r *AlterTopicResult) FromProto(proto *Ydb_Topic.AlterTopicResponse) error
type AutoPartitioningSettings ¶ added in v3.105.0
type AutoPartitioningSettings struct {
	AutoPartitioningStrategy           AutoPartitioningStrategy
	AutoPartitioningWriteSpeedStrategy AutoPartitioningWriteSpeedStrategy
}
    func (*AutoPartitioningSettings) FromProto ¶ added in v3.105.0
func (s *AutoPartitioningSettings) FromProto(proto *Ydb_Topic.AutoPartitioningSettings) error
func (*AutoPartitioningSettings) ToProto ¶ added in v3.105.0
func (s *AutoPartitioningSettings) ToProto() *Ydb_Topic.AutoPartitioningSettings
type AutoPartitioningStrategy ¶ added in v3.105.0
type AutoPartitioningStrategy int32
func (AutoPartitioningStrategy) ToProto ¶ added in v3.105.0
func (s AutoPartitioningStrategy) ToProto() Ydb_Topic.AutoPartitioningStrategy
type AutoPartitioningWriteSpeedStrategy ¶ added in v3.105.0
type AutoPartitioningWriteSpeedStrategy struct {
	StabilizationWindow    rawoptional.Duration
	UpUtilizationPercent   int32
	DownUtilizationPercent int32
}
    func (*AutoPartitioningWriteSpeedStrategy) FromProto ¶ added in v3.105.0
func (s *AutoPartitioningWriteSpeedStrategy) FromProto(speed *Ydb_Topic.AutoPartitioningWriteSpeedStrategy) error
func (*AutoPartitioningWriteSpeedStrategy) ToProto ¶ added in v3.105.0
func (s *AutoPartitioningWriteSpeedStrategy) ToProto() *Ydb_Topic.AutoPartitioningWriteSpeedStrategy
type Client ¶
type Client struct {
	// contains filtered or unexported fields
}
    func NewClient ¶
func NewClient(service Ydb_Topic_V1.TopicServiceClient) Client
func (*Client) AlterTopic ¶
func (c *Client) AlterTopic(ctx context.Context, req *AlterTopicRequest) (res AlterTopicResult, err error)
func (*Client) CreateTopic ¶
func (c *Client) CreateTopic( ctx context.Context, req *CreateTopicRequest, ) (res CreateTopicResult, err error)
func (*Client) DescribeConsumer ¶ added in v3.85.0
func (c *Client) DescribeConsumer(ctx context.Context, req DescribeConsumerRequest) ( res DescribeConsumerResult, err error, )
func (*Client) DescribeTopic ¶
func (c *Client) DescribeTopic(ctx context.Context, req DescribeTopicRequest) (res DescribeTopicResult, err error)
func (*Client) DropTopic ¶
func (c *Client) DropTopic( ctx context.Context, req DropTopicRequest, ) (res DropTopicResult, err error)
func (*Client) StreamRead ¶
func (c *Client) StreamRead( ctxStreamLifeTime context.Context, readerID int64, tracer *trace.Topic, ) (rawtopicreader.StreamReader, error)
func (*Client) StreamWrite ¶
func (c *Client) StreamWrite( ctxStreamLifeTime context.Context, tracer *trace.Topic, ) (*rawtopicwriter.StreamWriter, error)
func (*Client) UpdateOffsetsInTransaction ¶ added in v3.76.4
func (c *Client) UpdateOffsetsInTransaction( ctx context.Context, req *UpdateOffsetsInTransactionRequest, ) error
type Consumer ¶
type Consumer struct {
	Name            string
	Important       bool
	SupportedCodecs rawtopiccommon.SupportedCodecs
	ReadFrom        rawoptional.Time
	Attributes      map[string]string
}
    func (*Consumer) MustFromProto ¶
type CreateTopicRequest ¶
type CreateTopicRequest struct {
	OperationParams rawydb.OperationParams
	Path                              string
	PartitioningSettings              PartitioningSettings
	RetentionPeriod                   time.Duration
	RetentionStorageMB                int64
	SupportedCodecs                   rawtopiccommon.SupportedCodecs
	PartitionWriteSpeedBytesPerSecond int64
	PartitionWriteBurstBytes          int64
	Attributes                        map[string]string
	Consumers                         []Consumer
	MeteringMode                      MeteringMode
}
    func (*CreateTopicRequest) ToProto ¶
func (req *CreateTopicRequest) ToProto() *Ydb_Topic.CreateTopicRequest
type CreateTopicResult ¶
func (*CreateTopicResult) FromProto ¶
func (r *CreateTopicResult) FromProto(proto *Ydb_Topic.CreateTopicResponse) error
type DescribeConsumerRequest ¶ added in v3.85.0
type DescribeConsumerRequest struct {
	OperationParams rawydb.OperationParams
	Path            string
	Consumer        string
	IncludeStats    bool
}
    func (*DescribeConsumerRequest) ToProto ¶ added in v3.85.0
func (req *DescribeConsumerRequest) ToProto() *Ydb_Topic.DescribeConsumerRequest
type DescribeConsumerResult ¶ added in v3.85.0
type DescribeConsumerResultPartitionInfo ¶ added in v3.85.0
type DescribeConsumerResultPartitionInfo struct {
	PartitionID            int64
	Active                 bool
	ChildPartitionIDs      []int64
	ParentPartitionIDs     []int64
	PartitionStats         PartitionStats
	PartitionConsumerStats PartitionConsumerStats
}
    func (*DescribeConsumerResultPartitionInfo) FromProto ¶ added in v3.85.0
func (pi *DescribeConsumerResultPartitionInfo) FromProto(proto *Ydb_Topic.DescribeConsumerResult_PartitionInfo) error
type DescribeTopicRequest ¶
type DescribeTopicRequest struct {
	OperationParams rawydb.OperationParams
	Path            string
	IncludeStats    bool
}
    func (*DescribeTopicRequest) ToProto ¶
func (req *DescribeTopicRequest) ToProto() *Ydb_Topic.DescribeTopicRequest
type DescribeTopicResult ¶
type DescribeTopicResult struct {
	Operation rawydb.Operation
	Self                              rawscheme.Entry
	PartitioningSettings              PartitioningSettings
	Partitions                        []PartitionInfo
	RetentionPeriod                   time.Duration
	RetentionStorageMB                int64
	SupportedCodecs                   rawtopiccommon.SupportedCodecs
	PartitionWriteSpeedBytesPerSecond int64
	PartitionWriteBurstBytes          int64
	Attributes                        map[string]string
	Consumers                         []Consumer
	MeteringMode                      MeteringMode
}
    type DropTopicRequest ¶
type DropTopicRequest struct {
	OperationParams rawydb.OperationParams
	Path            string
}
    func (*DropTopicRequest) ToProto ¶
func (req *DropTopicRequest) ToProto() *Ydb_Topic.DropTopicRequest
type DropTopicResult ¶
func (*DropTopicResult) FromProto ¶
func (r *DropTopicResult) FromProto(proto *Ydb_Topic.DropTopicResponse) error
type MeteringMode ¶ added in v3.38.2
type MeteringMode int
type MultipleWindowsStat ¶ added in v3.85.0
func (*MultipleWindowsStat) MustFromProto ¶ added in v3.85.0
func (stat *MultipleWindowsStat) MustFromProto(proto *Ydb_Topic.MultipleWindowsStat)
type PartitionConsumerStats ¶ added in v3.85.0
type PartitionConsumerStats struct {
	LastReadOffset                 int64
	CommittedOffset                int64
	ReadSessionID                  string
	PartitionReadSessionCreateTime rawoptional.Time
	LastReadTime                   rawoptional.Time
	MaxReadTimeLag                 rawoptional.Duration
	MaxWriteTimeLag                rawoptional.Duration
	BytesRead                      MultipleWindowsStat
	ReaderName                     string
}
    func (*PartitionConsumerStats) FromProto ¶ added in v3.85.0
func (stats *PartitionConsumerStats) FromProto(proto *Ydb_Topic.DescribeConsumerResult_PartitionConsumerStats) error
type PartitionInfo ¶ added in v3.38.2
type PartitionInfo struct {
	PartitionID        int64
	Active             bool
	ChildPartitionIDs  []int64
	ParentPartitionIDs []int64
	PartitionStats     PartitionStats
}
    func (*PartitionInfo) FromProto ¶ added in v3.107.0
func (pi *PartitionInfo) FromProto(proto *Ydb_Topic.DescribeTopicResult_PartitionInfo) error
type PartitionStats ¶ added in v3.85.0
type PartitionStats struct {
	PartitionsOffset rawtopiccommon.OffsetRange
	StoreSizeBytes   int64
	LastWriteTime    rawoptional.Time
	MaxWriteTimeLag  rawoptional.Duration
	BytesWritten     MultipleWindowsStat
}
    func (*PartitionStats) FromProto ¶ added in v3.85.0
func (ps *PartitionStats) FromProto(proto *Ydb_Topic.PartitionStats) error
type PartitioningSettings ¶
type PartitioningSettings struct {
	MinActivePartitions      int64
	MaxActivePartitions      int64
	PartitionCountLimit      int64
	AutoPartitioningSettings AutoPartitioningSettings
}
    func (*PartitioningSettings) FromProto ¶
func (s *PartitioningSettings) FromProto(proto *Ydb_Topic.PartitioningSettings) error
func (*PartitioningSettings) ToProto ¶
func (s *PartitioningSettings) ToProto() *Ydb_Topic.PartitioningSettings
type UpdateOffsetsInTransactionRequest ¶ added in v3.76.4
type UpdateOffsetsInTransactionRequest struct {
	OperationParams rawydb.OperationParams
	Tx              rawtopiccommon.TransactionIdentity
	Topics          []UpdateOffsetsInTransactionRequest_TopicOffsets
	Consumer        string
}
    func (*UpdateOffsetsInTransactionRequest) ToProto ¶ added in v3.76.4
func (r *UpdateOffsetsInTransactionRequest) ToProto() *Ydb_Topic.UpdateOffsetsInTransactionRequest
type UpdateOffsetsInTransactionRequest_PartitionOffsets ¶ added in v3.76.4
type UpdateOffsetsInTransactionRequest_PartitionOffsets struct {
	PartitionID      int64
	PartitionOffsets []rawtopiccommon.OffsetRange
}
    type UpdateOffsetsInTransactionRequest_TopicOffsets ¶ added in v3.76.4
type UpdateOffsetsInTransactionRequest_TopicOffsets struct {
	Path       string // Topic path
	Partitions []UpdateOffsetsInTransactionRequest_PartitionOffsets
}
    
       Source Files
      ¶
      Source Files
      ¶
    
   Click to show internal directories. 
   Click to hide internal directories.