Package io.envoyproxy.envoy.config.filter.network.redis_proxy.v2

Class RedisProxy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisProxyOrBuilder, Serializable
    public final class RedisProxy
extends com.google.protobuf.GeneratedMessageV3
implements RedisProxyOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.config.filter.network.redis_proxy.v2.RedisProxy
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RedisProxy.Builder
      [#next-free-field: 7]
      static class  RedisProxy.ConnPoolSettings
      Redis connection pool settings.
      static interface  RedisProxy.ConnPoolSettingsOrBuilder  
      static class  RedisProxy.PrefixRoutes
      Protobuf type envoy.config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes
      static interface  RedisProxy.PrefixRoutesOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LATENCY_IN_MICROS_FIELD_NUMBER

        public static final int LATENCY_IN_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREFIX_ROUTES_FIELD_NUMBER

        public static final int PREFIX_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER

        public static final int DOWNSTREAM_AUTH_PASSWORD_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 prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefix in interface RedisProxyOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

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

      • getCluster

        @Deprecated
public String getCluster()
        Deprecated.
        envoy.config.filter.network.redis_proxy.v2.RedisProxy.cluster is deprecated. See envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto;l=189
         Name of cluster from cluster manager. See the :ref:`configuration section
 <arch_overview_redis_configuration>` of the architecture overview for recommendations on
 configuring the backing cluster.
 .. attention::
   This field is deprecated. Use a :ref:`catch_all
   route<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_route>`
   instead.
        string cluster = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getCluster in interface RedisProxyOrBuilder
        Returns:
        The cluster.

      • getClusterBytes

        @Deprecated
public com.google.protobuf.ByteString getClusterBytes()
        Deprecated.
        envoy.config.filter.network.redis_proxy.v2.RedisProxy.cluster is deprecated. See envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto;l=189
         Name of cluster from cluster manager. See the :ref:`configuration section
 <arch_overview_redis_configuration>` of the architecture overview for recommendations on
 configuring the backing cluster.
 .. attention::
   This field is deprecated. Use a :ref:`catch_all
   route<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_route>`
   instead.
        string cluster = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getClusterBytes in interface RedisProxyOrBuilder
        Returns:
        The bytes for cluster.

      • hasSettings

        public boolean hasSettings()
         Network settings for the connection pool to the upstream clusters.
        .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }
        Specified by:
        hasSettings in interface RedisProxyOrBuilder
        Returns:
        Whether the settings field is set.

      • getSettings

        public RedisProxy.ConnPoolSettings getSettings()
         Network settings for the connection pool to the upstream clusters.
        .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }
        Specified by:
        getSettings in interface RedisProxyOrBuilder
        Returns:
        The settings.

      • getLatencyInMicros

        public boolean getLatencyInMicros()
         Indicates that latency stat should be computed in microseconds. By default it is computed in
 milliseconds.
        bool latency_in_micros = 4;
        Specified by:
        getLatencyInMicros in interface RedisProxyOrBuilder
        Returns:
        The latencyInMicros.

      • hasPrefixRoutes

        public boolean hasPrefixRoutes()
         List of **unique** prefixes used to separate keys from different workloads to different
 clusters. Envoy will always favor the longest match first in case of overlap. A catch-all
 cluster can be used to forward commands when there is no match. Time complexity of the
 lookups are in O(min(longest key prefix, key length)).
 Example:
 .. code-block:: yaml
    prefix_routes:
      routes:
        - prefix: "ab"
          cluster: "cluster_a"
        - prefix: "abc"
          cluster: "cluster_b"
 When using the above routes, the following prefixes would be sent to:
 * ``get abc:users`` would retrieve the key 'abc:users' from cluster_b.
 * ``get ab:users`` would retrieve the key 'ab:users' from cluster_a.
 * ``get z:users`` would return a NoUpstreamHost error. A :ref:`catch-all
   route<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_route>`
   would have retrieved the key from that cluster instead.
 See the :ref:`configuration section
 <arch_overview_redis_configuration>` of the architecture overview for recommendations on
 configuring the backing clusters.
        .envoy.config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes prefix_routes = 5;
        Specified by:
        hasPrefixRoutes in interface RedisProxyOrBuilder
        Returns:
        Whether the prefixRoutes field is set.

      • getPrefixRoutes

        public RedisProxy.PrefixRoutes getPrefixRoutes()
         List of **unique** prefixes used to separate keys from different workloads to different
 clusters. Envoy will always favor the longest match first in case of overlap. A catch-all
 cluster can be used to forward commands when there is no match. Time complexity of the
 lookups are in O(min(longest key prefix, key length)).
 Example:
 .. code-block:: yaml
    prefix_routes:
      routes:
        - prefix: "ab"
          cluster: "cluster_a"
        - prefix: "abc"
          cluster: "cluster_b"
 When using the above routes, the following prefixes would be sent to:
 * ``get abc:users`` would retrieve the key 'abc:users' from cluster_b.
 * ``get ab:users`` would retrieve the key 'ab:users' from cluster_a.
 * ``get z:users`` would return a NoUpstreamHost error. A :ref:`catch-all
   route<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_route>`
   would have retrieved the key from that cluster instead.
 See the :ref:`configuration section
 <arch_overview_redis_configuration>` of the architecture overview for recommendations on
 configuring the backing clusters.
        .envoy.config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes prefix_routes = 5;
        Specified by:
        getPrefixRoutes in interface RedisProxyOrBuilder
        Returns:
        The prefixRoutes.

      • getPrefixRoutesOrBuilder

        public RedisProxy.PrefixRoutesOrBuilder getPrefixRoutesOrBuilder()
         List of **unique** prefixes used to separate keys from different workloads to different
 clusters. Envoy will always favor the longest match first in case of overlap. A catch-all
 cluster can be used to forward commands when there is no match. Time complexity of the
 lookups are in O(min(longest key prefix, key length)).
 Example:
 .. code-block:: yaml
    prefix_routes:
      routes:
        - prefix: "ab"
          cluster: "cluster_a"
        - prefix: "abc"
          cluster: "cluster_b"
 When using the above routes, the following prefixes would be sent to:
 * ``get abc:users`` would retrieve the key 'abc:users' from cluster_b.
 * ``get ab:users`` would retrieve the key 'ab:users' from cluster_a.
 * ``get z:users`` would return a NoUpstreamHost error. A :ref:`catch-all
   route<envoy_api_field_config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes.catch_all_route>`
   would have retrieved the key from that cluster instead.
 See the :ref:`configuration section
 <arch_overview_redis_configuration>` of the architecture overview for recommendations on
 configuring the backing clusters.
        .envoy.config.filter.network.redis_proxy.v2.RedisProxy.PrefixRoutes prefix_routes = 5;
        Specified by:
        getPrefixRoutesOrBuilder in interface RedisProxyOrBuilder

      • hasDownstreamAuthPassword

        public boolean hasDownstreamAuthPassword()
         Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other
 command. If an AUTH command's password matches this password, an "OK" response will be returned
 to the client. If the AUTH command password does not match this password, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when this
 password is set, then a "NOAUTH Authentication required." error response will be sent to the
 client. If an AUTH command is received when the password is not set, then an "ERR Client sent
 AUTH, but no password is set" error will be returned.
        .envoy.api.v2.core.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];
        Specified by:
        hasDownstreamAuthPassword in interface RedisProxyOrBuilder
        Returns:
        Whether the downstreamAuthPassword field is set.

      • getDownstreamAuthPassword

        public DataSource getDownstreamAuthPassword()
         Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other
 command. If an AUTH command's password matches this password, an "OK" response will be returned
 to the client. If the AUTH command password does not match this password, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when this
 password is set, then a "NOAUTH Authentication required." error response will be sent to the
 client. If an AUTH command is received when the password is not set, then an "ERR Client sent
 AUTH, but no password is set" error will be returned.
        .envoy.api.v2.core.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getDownstreamAuthPassword in interface RedisProxyOrBuilder
        Returns:
        The downstreamAuthPassword.

      • getDownstreamAuthPasswordOrBuilder

        public DataSourceOrBuilder getDownstreamAuthPasswordOrBuilder()
         Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other
 command. If an AUTH command's password matches this password, an "OK" response will be returned
 to the client. If the AUTH command password does not match this password, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when this
 password is set, then a "NOAUTH Authentication required." error response will be sent to the
 client. If an AUTH command is received when the password is not set, then an "ERR Client sent
 AUTH, but no password is set" error will be returned.
        .envoy.api.v2.core.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getDownstreamAuthPasswordOrBuilder in interface RedisProxyOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static RedisProxy getDefaultInstance()

      • parser

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

      • getParserForType

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