kafkav3

Documentation

Index

• Variables
• type KafkaCodecConfig
  • func (*KafkaCodecConfig) Descriptor() ([]byte, []int)
  • func (*KafkaCodecConfig) ProtoMessage()
  • func (x *KafkaCodecConfig) ProtoReflect() protoreflect.Message
  • func (x *KafkaCodecConfig) Reset()
  • func (x *KafkaCodecConfig) String() string
  • func (m *KafkaCodecConfig) Validate() error
  • func (m *KafkaCodecConfig) ValidateAll() error
• type KafkaCodecConfigMultiError
  • func (m KafkaCodecConfigMultiError) AllErrors() []error
  • func (m KafkaCodecConfigMultiError) Error() string
• type KafkaCodecConfigValidationError
  • func (e KafkaCodecConfigValidationError) Cause() error
  • func (e KafkaCodecConfigValidationError) Error() string
  • func (e KafkaCodecConfigValidationError) ErrorName() string
  • func (e KafkaCodecConfigValidationError) Field() string
  • func (e KafkaCodecConfigValidationError) Key() bool
  • func (e KafkaCodecConfigValidationError) Reason() string

Variables

var File_contrib_envoy_extensions_filters_network_generic_proxy_codecs_kafka_v3_kafka_proto protoreflect.FileDescriptor

Types

type KafkaCodecConfig

type KafkaCodecConfig struct {
	// contains filtered or unexported fields
}

Configuration for Kafka codec. This codec gives the generic proxy the ability to proxy Kafka traffic. But note any route configuration for Kafka traffic is not supported yet. The generic proxy can only used to generate logs or metrics for Kafka traffic but cannot do matching or routing.

.. note::

The codec can currently only be used in the sidecar mode. And to ensure the codec works
properly, please make sure the following conditions are met:

1. The generic proxy must be configured with a wildcard route that matches all traffic.
2. The target cluster must be configured as a original destination cluster.
3. The :ref:`bind_upstream_connection
   <envoy_v3_api_field_extensions.filters.network.generic_proxy.router.v3.Router.bind_upstream_connection>`
   of generic proxy router must be set to true to ensure same upstream connection is used
   for all traffic from same downstream connection.

func (*KafkaCodecConfig) Descriptor

func (*KafkaCodecConfig) Descriptor() ([]byte, []int)

Deprecated: Use KafkaCodecConfig.ProtoReflect.Descriptor instead.

func (*KafkaCodecConfig) ProtoMessage

func (*KafkaCodecConfig) ProtoMessage()

func (*KafkaCodecConfig) ProtoReflect

func (x *KafkaCodecConfig) ProtoReflect() protoreflect.Message

func (*KafkaCodecConfig) Reset

func (x *KafkaCodecConfig) Reset()

func (*KafkaCodecConfig) String

func (x *KafkaCodecConfig) String() string

func (*KafkaCodecConfig) Validate

func (m *KafkaCodecConfig) Validate() error

Validate checks the field values on KafkaCodecConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*KafkaCodecConfig) ValidateAll

func (m *KafkaCodecConfig) ValidateAll() error

ValidateAll checks the field values on KafkaCodecConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in KafkaCodecConfigMultiError, or nil if none found.

type KafkaCodecConfigMultiError

type KafkaCodecConfigMultiError []error

KafkaCodecConfigMultiError is an error wrapping multiple validation errors returned by KafkaCodecConfig.ValidateAll() if the designated constraints aren't met.

func (KafkaCodecConfigMultiError) AllErrors

func (m KafkaCodecConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (KafkaCodecConfigMultiError) Error

func (m KafkaCodecConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type KafkaCodecConfigValidationError

type KafkaCodecConfigValidationError struct {
	// contains filtered or unexported fields
}

KafkaCodecConfigValidationError is the validation error returned by KafkaCodecConfig.Validate if the designated constraints aren't met.

func (KafkaCodecConfigValidationError) Cause

func (e KafkaCodecConfigValidationError) Cause() error

Cause function returns cause value.

func (KafkaCodecConfigValidationError) Error

func (e KafkaCodecConfigValidationError) Error() string

Error satisfies the builtin error interface

func (KafkaCodecConfigValidationError) ErrorName

func (e KafkaCodecConfigValidationError) ErrorName() string

ErrorName returns error name.

func (KafkaCodecConfigValidationError) Field

func (e KafkaCodecConfigValidationError) Field() string

Field function returns field value.

func (KafkaCodecConfigValidationError) Key

func (e KafkaCodecConfigValidationError) Key() bool

Key function returns key value.

func (KafkaCodecConfigValidationError) Reason

func (e KafkaCodecConfigValidationError) Reason() string

Reason function returns reason value.