Package io.envoyproxy.envoy.extensions.filters.network.zookeeper_proxy.v3

Class ZooKeeperProxy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ZooKeeperProxyOrBuilder, Serializable
    public final class ZooKeeperProxy
extends com.google.protobuf.GeneratedMessageV3
implements ZooKeeperProxyOrBuilder
     [#next-free-field: 9]
    Protobuf type envoy.extensions.filters.network.zookeeper_proxy.v3.ZooKeeperProxy
    See Also:
    Serialized Form

    • Field Detail

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACCESS_LOG_FIELD_NUMBER

        public static final int ACCESS_LOG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_PACKET_BYTES_FIELD_NUMBER

        public static final int MAX_PACKET_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_LATENCY_THRESHOLD_METRICS_FIELD_NUMBER

        public static final int ENABLE_LATENCY_THRESHOLD_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_LATENCY_THRESHOLD_FIELD_NUMBER

        public static final int DEFAULT_LATENCY_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LATENCY_THRESHOLD_OVERRIDES_FIELD_NUMBER

        public static final int LATENCY_THRESHOLD_OVERRIDES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_PER_OPCODE_REQUEST_BYTES_METRICS_FIELD_NUMBER

        public static final int ENABLE_PER_OPCODE_REQUEST_BYTES_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_PER_OPCODE_RESPONSE_BYTES_METRICS_FIELD_NUMBER

        public static final int ENABLE_PER_OPCODE_RESPONSE_BYTES_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getStatPrefix

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

      • getStatPrefixBytes

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

      • getAccessLog

        public String getAccessLog()
         [#not-implemented-hide:] The optional path to use for writing ZooKeeper access logs.
 If the access log field is empty, access logs will not be written.
        string access_log = 2;
        Specified by:
        getAccessLog in interface ZooKeeperProxyOrBuilder
        Returns:
        The accessLog.

      • getAccessLogBytes

        public com.google.protobuf.ByteString getAccessLogBytes()
         [#not-implemented-hide:] The optional path to use for writing ZooKeeper access logs.
 If the access log field is empty, access logs will not be written.
        string access_log = 2;
        Specified by:
        getAccessLogBytes in interface ZooKeeperProxyOrBuilder
        Returns:
        The bytes for accessLog.

      • hasMaxPacketBytes

        public boolean hasMaxPacketBytes()
         Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.
 The value here should match the jute.maxbuffer property in your cluster configuration:
 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options
 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
        .google.protobuf.UInt32Value max_packet_bytes = 3;
        Specified by:
        hasMaxPacketBytes in interface ZooKeeperProxyOrBuilder
        Returns:
        Whether the maxPacketBytes field is set.

      • getMaxPacketBytes

        public com.google.protobuf.UInt32Value getMaxPacketBytes()
         Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.
 The value here should match the jute.maxbuffer property in your cluster configuration:
 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options
 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
        .google.protobuf.UInt32Value max_packet_bytes = 3;
        Specified by:
        getMaxPacketBytes in interface ZooKeeperProxyOrBuilder
        Returns:
        The maxPacketBytes.

      • getMaxPacketBytesOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getMaxPacketBytesOrBuilder()
         Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.
 The value here should match the jute.maxbuffer property in your cluster configuration:
 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options
 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
        .google.protobuf.UInt32Value max_packet_bytes = 3;
        Specified by:
        getMaxPacketBytesOrBuilder in interface ZooKeeperProxyOrBuilder

      • getEnableLatencyThresholdMetrics

        public boolean getEnableLatencyThresholdMetrics()
         Whether to emit latency threshold metrics. If not set, it defaults to false.
 If false, setting ``default_latency_threshold`` and ``latency_threshold_overrides`` will not have effect.
        bool enable_latency_threshold_metrics = 4;
        Specified by:
        getEnableLatencyThresholdMetrics in interface ZooKeeperProxyOrBuilder
        Returns:
        The enableLatencyThresholdMetrics.

      • hasDefaultLatencyThreshold

        public boolean hasDefaultLatencyThreshold()
         The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).
 https://sre.google/workbook/implementing-slos/
 If it is not set, the default value is 100 milliseconds.
        .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }
        Specified by:
        hasDefaultLatencyThreshold in interface ZooKeeperProxyOrBuilder
        Returns:
        Whether the defaultLatencyThreshold field is set.

      • getDefaultLatencyThreshold

        public com.google.protobuf.Duration getDefaultLatencyThreshold()
         The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).
 https://sre.google/workbook/implementing-slos/
 If it is not set, the default value is 100 milliseconds.
        .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }
        Specified by:
        getDefaultLatencyThreshold in interface ZooKeeperProxyOrBuilder
        Returns:
        The defaultLatencyThreshold.

      • getDefaultLatencyThresholdOrBuilder

        public com.google.protobuf.DurationOrBuilder getDefaultLatencyThresholdOrBuilder()
         The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).
 https://sre.google/workbook/implementing-slos/
 If it is not set, the default value is 100 milliseconds.
        .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }
        Specified by:
        getDefaultLatencyThresholdOrBuilder in interface ZooKeeperProxyOrBuilder

      • getLatencyThresholdOverridesList

        public List<LatencyThresholdOverride> getLatencyThresholdOverridesList()
         List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
        repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;
        Specified by:
        getLatencyThresholdOverridesList in interface ZooKeeperProxyOrBuilder

      • getLatencyThresholdOverridesOrBuilderList

        public List<? extends LatencyThresholdOverrideOrBuilder> getLatencyThresholdOverridesOrBuilderList()
         List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
        repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;
        Specified by:
        getLatencyThresholdOverridesOrBuilderList in interface ZooKeeperProxyOrBuilder

      • getLatencyThresholdOverridesCount

        public int getLatencyThresholdOverridesCount()
         List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
        repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;
        Specified by:
        getLatencyThresholdOverridesCount in interface ZooKeeperProxyOrBuilder

      • getLatencyThresholdOverrides

        public LatencyThresholdOverride getLatencyThresholdOverrides​(int index)
         List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
        repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;
        Specified by:
        getLatencyThresholdOverrides in interface ZooKeeperProxyOrBuilder

      • getLatencyThresholdOverridesOrBuilder

        public LatencyThresholdOverrideOrBuilder getLatencyThresholdOverridesOrBuilder​(int index)
         List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
        repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;
        Specified by:
        getLatencyThresholdOverridesOrBuilder in interface ZooKeeperProxyOrBuilder

      • getEnablePerOpcodeRequestBytesMetrics

        public boolean getEnablePerOpcodeRequestBytesMetrics()
         Whether to emit per opcode request bytes metrics. If not set, it defaults to false.
        bool enable_per_opcode_request_bytes_metrics = 7;
        Specified by:
        getEnablePerOpcodeRequestBytesMetrics in interface ZooKeeperProxyOrBuilder
        Returns:
        The enablePerOpcodeRequestBytesMetrics.

      • getEnablePerOpcodeResponseBytesMetrics

        public boolean getEnablePerOpcodeResponseBytesMetrics()
         Whether to emit per opcode response bytes metrics. If not set, it defaults to false.
        bool enable_per_opcode_response_bytes_metrics = 8;
        Specified by:
        getEnablePerOpcodeResponseBytesMetrics in interface ZooKeeperProxyOrBuilder
        Returns:
        The enablePerOpcodeResponseBytesMetrics.

      • 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 ZooKeeperProxy parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static ZooKeeperProxy getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ZooKeeperProxy> 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 ZooKeeperProxy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder