Package io.envoyproxy.envoy.config.filter.network.kafka_broker.v2alpha1

Class KafkaBroker

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.network.kafka_broker.v2alpha1.KafkaBroker
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KafkaBrokerOrBuilder, Serializable
public final class KafkaBroker extends com.google.protobuf.GeneratedMessageV3 implements KafkaBrokerOrBuilder
 [#protodoc-title: Kafka Broker]
 Kafka Broker :ref:`configuration overview <config_network_filters_kafka_broker>`.
 [#extension: envoy.filters.network.kafka_broker]
 [#next-free-field: 6]
Protobuf type envoy.config.filter.network.kafka_broker.v2alpha1.KafkaBroker
See Also:

  • Field Details

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • FORCE_RESPONSE_REWRITE_FIELD_NUMBER

      public static final int FORCE_RESPONSE_REWRITE_FIELD_NUMBER
      See Also:

    • ID_BASED_BROKER_ADDRESS_REWRITE_SPEC_FIELD_NUMBER

      public static final int ID_BASED_BROKER_ADDRESS_REWRITE_SPEC_FIELD_NUMBER
      See Also:

    • API_KEYS_ALLOWED_FIELD_NUMBER

      public static final int API_KEYS_ALLOWED_FIELD_NUMBER
      See Also:

    • API_KEYS_DENIED_FIELD_NUMBER

      public static final int API_KEYS_DENIED_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getBrokerAddressRewriteSpecCase

      public KafkaBroker.BrokerAddressRewriteSpecCase getBrokerAddressRewriteSpecCase()
      Specified by:
      getBrokerAddressRewriteSpecCase in interface KafkaBrokerOrBuilder

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting :ref:`statistics <config_network_filters_kafka_broker_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface KafkaBrokerOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting :ref:`statistics <config_network_filters_kafka_broker_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface KafkaBrokerOrBuilder
      Returns:
      The bytes for statPrefix.

    • getForceResponseRewrite

      public boolean getForceResponseRewrite()
       Set to true if broker filter should attempt to serialize the received responses from the
 upstream broker instead of passing received bytes as is.
 Disabled by default.
      bool force_response_rewrite = 2;
      Specified by:
      getForceResponseRewrite in interface KafkaBrokerOrBuilder
      Returns:
      The forceResponseRewrite.

    • hasIdBasedBrokerAddressRewriteSpec

      public boolean hasIdBasedBrokerAddressRewriteSpec()
       Broker address rewrite rules that match by broker ID.
      .envoy.config.filter.network.kafka_broker.v2alpha1.IdBasedBrokerRewriteSpec id_based_broker_address_rewrite_spec = 3;
      Specified by:
      hasIdBasedBrokerAddressRewriteSpec in interface KafkaBrokerOrBuilder
      Returns:
      Whether the idBasedBrokerAddressRewriteSpec field is set.

    • getIdBasedBrokerAddressRewriteSpec

      public IdBasedBrokerRewriteSpec getIdBasedBrokerAddressRewriteSpec()
       Broker address rewrite rules that match by broker ID.
      .envoy.config.filter.network.kafka_broker.v2alpha1.IdBasedBrokerRewriteSpec id_based_broker_address_rewrite_spec = 3;
      Specified by:
      getIdBasedBrokerAddressRewriteSpec in interface KafkaBrokerOrBuilder
      Returns:
      The idBasedBrokerAddressRewriteSpec.

    • getIdBasedBrokerAddressRewriteSpecOrBuilder

      public IdBasedBrokerRewriteSpecOrBuilder getIdBasedBrokerAddressRewriteSpecOrBuilder()
       Broker address rewrite rules that match by broker ID.
      .envoy.config.filter.network.kafka_broker.v2alpha1.IdBasedBrokerRewriteSpec id_based_broker_address_rewrite_spec = 3;
      Specified by:
      getIdBasedBrokerAddressRewriteSpecOrBuilder in interface KafkaBrokerOrBuilder

    • getApiKeysAllowedList

      public List<Integer> getApiKeysAllowedList()
       Optional list of allowed Kafka API keys. Only requests with provided API keys will be
 routed, otherwise the connection will be closed. No effect if empty.
      repeated uint32 api_keys_allowed = 4 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysAllowedList in interface KafkaBrokerOrBuilder
      Returns:
      A list containing the apiKeysAllowed.

    • getApiKeysAllowedCount

      public int getApiKeysAllowedCount()
       Optional list of allowed Kafka API keys. Only requests with provided API keys will be
 routed, otherwise the connection will be closed. No effect if empty.
      repeated uint32 api_keys_allowed = 4 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysAllowedCount in interface KafkaBrokerOrBuilder
      Returns:
      The count of apiKeysAllowed.

    • getApiKeysAllowed

      public int getApiKeysAllowed(int index)
       Optional list of allowed Kafka API keys. Only requests with provided API keys will be
 routed, otherwise the connection will be closed. No effect if empty.
      repeated uint32 api_keys_allowed = 4 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysAllowed in interface KafkaBrokerOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The apiKeysAllowed at the given index.

    • getApiKeysDeniedList

      public List<Integer> getApiKeysDeniedList()
       Optional list of denied Kafka API keys. Requests with API keys matching this list will have
 the connection closed. No effect if empty.
      repeated uint32 api_keys_denied = 5 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysDeniedList in interface KafkaBrokerOrBuilder
      Returns:
      A list containing the apiKeysDenied.

    • getApiKeysDeniedCount

      public int getApiKeysDeniedCount()
       Optional list of denied Kafka API keys. Requests with API keys matching this list will have
 the connection closed. No effect if empty.
      repeated uint32 api_keys_denied = 5 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysDeniedCount in interface KafkaBrokerOrBuilder
      Returns:
      The count of apiKeysDenied.

    • getApiKeysDenied

      public int getApiKeysDenied(int index)
       Optional list of denied Kafka API keys. Requests with API keys matching this list will have
 the connection closed. No effect if empty.
      repeated uint32 api_keys_denied = 5 [(.validate.rules) = { ... }
      Specified by:
      getApiKeysDenied in interface KafkaBrokerOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The apiKeysDenied at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static KafkaBroker parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KafkaBroker parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KafkaBroker parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KafkaBroker parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KafkaBroker parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KafkaBroker parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KafkaBroker parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public KafkaBroker.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static KafkaBroker.Builder newBuilder()

    • newBuilder

      public static KafkaBroker.Builder newBuilder(KafkaBroker prototype)

    • toBuilder

      public KafkaBroker.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected KafkaBroker.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static KafkaBroker getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KafkaBroker> parser()

    • getParserForType

      public com.google.protobuf.Parser<KafkaBroker> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public KafkaBroker getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder