describeconfigs

Documentation

Index

• type Request
  • func (r *Request) ApiKey() protocol.ApiKey
  • func (r *Request) Broker(cluster protocol.Cluster) (protocol.Broker, error)
  • func (r *Request) Split(cluster protocol.Cluster) ([]protocol.Message, protocol.Merger, error)
• type RequestResource
• type Response
  • func (r *Response) ApiKey() protocol.ApiKey
  • func (r *Response) Merge(requests []protocol.Message, results []interface{}) (protocol.Message, error)
• type ResponseConfigEntry
• type ResponseConfigSynonym
• type ResponseResource

Types

type Request

type Request struct {
	Resources            []RequestResource `kafka:"min=v0,max=v3"`
	IncludeSynonyms      bool              `kafka:"min=v1,max=v3"`
	IncludeDocumentation bool              `kafka:"min=v3,max=v3"`
}

Detailed API definition: https://kafka.apache.org/protocol#The_Messages_DescribeConfigs

func (*Request) ApiKey

func (r *Request) ApiKey() protocol.ApiKey

func (*Request) Broker

func (r *Request) Broker(cluster protocol.Cluster) (protocol.Broker, error)

func (*Request) Split

func (r *Request) Split(cluster protocol.Cluster) (
	[]protocol.Message,
	protocol.Merger,
	error,
)

type RequestResource

type RequestResource struct {
	ResourceType int8     `kafka:"min=v0,max=v3"`
	ResourceName string   `kafka:"min=v0,max=v3"`
	ConfigNames  []string `kafka:"min=v0,max=v3,nullable"`
}

type Response

type Response struct {
	ThrottleTimeMs int32              `kafka:"min=v0,max=v3"`
	Resources      []ResponseResource `kafka:"min=v0,max=v3"`
}

func (*Response) ApiKey

func (r *Response) ApiKey() protocol.ApiKey

func (*Response) Merge

func (r *Response) Merge(requests []protocol.Message, results []interface{}) (
	protocol.Message,
	error,
)

type ResponseConfigEntry

type ResponseConfigEntry struct {
	ConfigName          string                  `kafka:"min=v0,max=v3"`
	ConfigValue         string                  `kafka:"min=v0,max=v3,nullable"`
	ReadOnly            bool                    `kafka:"min=v0,max=v3"`
	IsDefault           bool                    `kafka:"min=v0,max=v0"`
	ConfigSource        int8                    `kafka:"min=v1,max=v3"`
	IsSensitive         bool                    `kafka:"min=v0,max=v3"`
	ConfigSynonyms      []ResponseConfigSynonym `kafka:"min=v1,max=v3"`
	ConfigType          int8                    `kafka:"min=v3,max=v3"`
	ConfigDocumentation string                  `kafka:"min=v3,max=v3,nullable"`
}

type ResponseConfigSynonym

type ResponseConfigSynonym struct {
	ConfigName   string `kafka:"min=v1,max=v3"`
	ConfigValue  string `kafka:"min=v1,max=v3,nullable"`
	ConfigSource int8   `kafka:"min=v1,max=v3"`
}

type ResponseResource

type ResponseResource struct {
	ErrorCode     int16                 `kafka:"min=v0,max=v3"`
	ErrorMessage  string                `kafka:"min=v0,max=v3,nullable"`
	ResourceType  int8                  `kafka:"min=v0,max=v3"`
	ResourceName  string                `kafka:"min=v0,max=v3"`
	ConfigEntries []ResponseConfigEntry `kafka:"min=v0,max=v3"`
}