Documentation
¶
Overview ¶
Package kafka implements the Kafka service handling requests and responses.
Package kafka implements the Kafka service handling requests and responses.
Package kafka implements the Kafka service handling requests and responses.
Package kafka implements the Kafka service handling requests and responses.
Package kafka implements the Kafka service handling requests and responses.
Index ¶
- Constants
- type ConfigOperation
- type ConfigOperations
- type Metadata
- type ResourceACLs
- type ResourceConfigs
- type Service
- func (s *Service) AlterAllBrokerConfigs(configOps ConfigOperations, validateOnly bool) error
- func (s *Service) AlterBrokerConfigs(brokerID string, configOps ConfigOperations, validateOnly bool) error
- func (s *Service) AlterPartitionAssignments(topic string, assignments def.PartitionAssignments) error
- func (s *Service) AlterTopicConfigs(topic string, configOps ConfigOperations, validateOnly bool) error
- func (s *Service) CreateACLs(name string, resourceType string, acls def.ACLEntryGroups) error
- func (s *Service) CreatePartitions(topic string, partitions int, assignments def.PartitionAssignments, ...) error
- func (s *Service) CreateTopic(topicDef def.TopicDefinition, assignments def.PartitionAssignments, ...) error
- func (s *Service) DeleteACLs(name string, resourceType string, acls def.ACLEntryGroups) error
- func (s *Service) DescribeAllBrokerConfigs() (def.Configs, error)
- func (s *Service) DescribeAllResourceACLs(resourceType string) ([]ResourceACLs, error)
- func (s *Service) DescribeBrokerConfigs(brokerID string) (def.Configs, error)
- func (s *Service) DescribeMetadata(topics []string, errorOnNonExistence bool) (*Metadata, error)
- func (s *Service) DescribeResourceACLs(name string, resourceType string) (def.ACLEntryGroups, error)
- func (s *Service) DescribeTopicConfigs(topics []string) ([]ResourceConfigs, error)
- func (s *Service) IsKafkaReady(minBrokers int, timeoutSec int) bool
- func (s *Service) ListPartitionReassignments(topic string, partitions []int32) (meta.PartitionReassignments, error)
- func (s *Service) NewConfigOps(localConfigs def.ConfigsMap, remoteConfigsMap def.ConfigsMap, ...) (ConfigOperations, error)
- func (s *Service) TryRequestTopic(defMetadata def.ResourceMetadataDefinition) (*def.TopicDefinition, def.Configs, meta.Brokers, error)
- type TopicMetadata
Constants ¶
const ( SetConfigOperation int8 = 0 DeleteConfigOperation int8 = 1 )
Config operation types.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConfigOperation ¶
type ConfigOperation struct {
Name string
Value *string
Op int8 // 0: SET, 1: DELETE, 2: APPEND, 3: SUBTRACT.
}
ConfigOperation represents an alter config operation.
type ConfigOperations ¶
type ConfigOperations []ConfigOperation
ConfigOperations represents a slice of ConfigOperation.
func (ConfigOperations) Contains ¶
func (c ConfigOperations) Contains(name string) bool
Contains determines if the specified config key name exists.
func (ConfigOperations) ContainsOp ¶
func (c ConfigOperations) ContainsOp(operation int8) bool
ContainsOp determines if the specified operation type exists.
type Metadata ¶
type Metadata struct {
ClusterID string
Brokers meta.Brokers
Topics []TopicMetadata
}
Metadata represents cluster metadata.
type ResourceACLs ¶ added in v0.1.0
type ResourceACLs struct {
ResourceName string
ResourceType string
ACLs def.ACLEntryGroups
}
ResourceACLs represents ACLs for a named resource.
type ResourceConfigs ¶
ResourceConfigs represents configs for a named resource.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service represents a Kafka service.
func NewService ¶
NewService creates a new Kafka service.
func (*Service) AlterAllBrokerConfigs ¶
func (s *Service) AlterAllBrokerConfigs(configOps ConfigOperations, validateOnly bool) error
AlterAllBrokerConfigs executes a request to alter cluster-wide broker configs (Kafka 0.11.0+/2.3.0+).
func (*Service) AlterBrokerConfigs ¶
func (s *Service) AlterBrokerConfigs(brokerID string, configOps ConfigOperations, validateOnly bool) error
AlterBrokerConfigs executes a request to alter broker configs (Kafka 0.11.0+/2.3.0+).
func (*Service) AlterPartitionAssignments ¶
func (s *Service) AlterPartitionAssignments( topic string, assignments def.PartitionAssignments, ) error
AlterPartitionAssignments executes a request to alter partition assignments (Kafka 2.4.0+).
func (*Service) AlterTopicConfigs ¶
func (s *Service) AlterTopicConfigs(topic string, configOps ConfigOperations, validateOnly bool) error
AlterTopicConfigs executes a request to alter topic configs (Kafka 0.11.0+/2.3.0+).
func (*Service) CreateACLs ¶ added in v0.1.0
CreateACLs executes a request to create ACLs (Kafka 0.11.0+).
func (*Service) CreatePartitions ¶
func (s *Service) CreatePartitions( topic string, partitions int, assignments def.PartitionAssignments, validateOnly bool, ) error
CreatePartitions executes a request to create partitions (Kafka 0.10.0+).
func (*Service) CreateTopic ¶
func (s *Service) CreateTopic( topicDef def.TopicDefinition, assignments def.PartitionAssignments, validateOnly bool, ) error
CreateTopic executes a request to create a topic (Kafka 0.10.1+).
func (*Service) DeleteACLs ¶ added in v0.1.0
DeleteACLs executes a request to delete acls (Kafka 0.11.0+).
func (*Service) DescribeAllBrokerConfigs ¶
DescribeAllBrokerConfigs executes a request to describe all broker configs (Kafka 0.11.0+).
func (*Service) DescribeAllResourceACLs ¶ added in v0.1.0
func (s *Service) DescribeAllResourceACLs( resourceType string, ) ([]ResourceACLs, error)
DescribeAllResourceACLs executes a request to describe ACLs for all resources (Kafka 0.11.0+).
func (*Service) DescribeBrokerConfigs ¶
DescribeBrokerConfigs executes a request to describe broker configs (Kafka 0.11.0+).
func (*Service) DescribeMetadata ¶
DescribeMetadata executes a request for metadata (Kafka 0.8.0+).
func (*Service) DescribeResourceACLs ¶ added in v0.1.0
func (s *Service) DescribeResourceACLs( name string, resourceType string, ) (def.ACLEntryGroups, error)
DescribeResourceACLs executes a request to describe ACLs of a specific resource (Kafka 0.11.0+).
func (*Service) DescribeTopicConfigs ¶
func (s *Service) DescribeTopicConfigs(topics []string) ([]ResourceConfigs, error)
DescribeTopicConfigs executes a request to describe topic configs (Kafka 0.11.0+).
func (*Service) IsKafkaReady ¶
IsKafkaReady executes describe cluster requests until a minimum number of brokers are alive (Kafka 2.8.0+).
func (*Service) ListPartitionReassignments ¶
func (s *Service) ListPartitionReassignments( topic string, partitions []int32, ) (meta.PartitionReassignments, error)
ListPartitionReassignments executes a request to list partition reassignments (Kafka 2.4.0+).
func (*Service) NewConfigOps ¶
func (s *Service) NewConfigOps( localConfigs def.ConfigsMap, remoteConfigsMap def.ConfigsMap, remoteConfigs def.Configs, deleteUndefinedConfigs bool, ) (ConfigOperations, error)
NewConfigOps creates alter configs operations.
func (*Service) TryRequestTopic ¶
func (s *Service) TryRequestTopic(defMetadata def.ResourceMetadataDefinition) ( *def.TopicDefinition, def.Configs, meta.Brokers, error, )
TryRequestTopic executes a request for the metadata of a topic that may or may not exist (Kafka 0.11.0+).
type TopicMetadata ¶
type TopicMetadata struct {
Topic string
PartitionAssignments def.PartitionAssignments
PartitionRackAssignments def.PartitionRackAssignments
Exists bool
}
TopicMetadata represents topic metadata.