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

Class RedisProxy.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>
io.envoyproxy.envoy.config.filter.network.redis_proxy.v2.RedisProxy.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisProxyOrBuilder, Cloneable
Enclosing class:
RedisProxy
public static final class RedisProxy.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder> implements RedisProxyOrBuilder
 [#next-free-field: 7]
Protobuf type envoy.config.filter.network.redis_proxy.v2.RedisProxy

  • Method Details

    • 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.Builder<RedisProxy.Builder>

    • clear

      public RedisProxy.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public RedisProxy.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • setField

      public RedisProxy.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • clearField

      public RedisProxy.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • clearOneof

      public RedisProxy.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • setRepeatedField

      public RedisProxy.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • addRepeatedField

      public RedisProxy.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • mergeFrom

      public RedisProxy.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.Builder>

    • mergeFrom

      public RedisProxy.Builder mergeFrom(RedisProxy other)

    • isInitialized

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

    • mergeFrom

      public RedisProxy.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.Builder>
      Throws:
      IOException

    • 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.

    • setStatPrefix

      public RedisProxy.Builder setStatPrefix(String value)
       The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The statPrefix to set.
      Returns:
      This builder for chaining.

    • clearStatPrefix

      public RedisProxy.Builder clearStatPrefix()
       The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setStatPrefixBytes

      public RedisProxy.Builder setStatPrefixBytes(com.google.protobuf.ByteString value)
       The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for statPrefix to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCluster

      @Deprecated public RedisProxy.Builder setCluster(String value)
      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];
      Parameters:
      value - The cluster to set.
      Returns:
      This builder for chaining.

    • clearCluster

      @Deprecated public RedisProxy.Builder clearCluster()
      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];
      Returns:
      This builder for chaining.

    • setClusterBytes

      @Deprecated public RedisProxy.Builder setClusterBytes(com.google.protobuf.ByteString value)
      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];
      Parameters:
      value - The bytes for cluster to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSettings

      public RedisProxy.Builder setSettings(RedisProxy.ConnPoolSettings value)
       Network settings for the connection pool to the upstream clusters.
      .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

    • setSettings

      public RedisProxy.Builder setSettings(RedisProxy.ConnPoolSettings.Builder builderForValue)
       Network settings for the connection pool to the upstream clusters.
      .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

    • mergeSettings

      public RedisProxy.Builder mergeSettings(RedisProxy.ConnPoolSettings value)
       Network settings for the connection pool to the upstream clusters.
      .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

    • clearSettings

      public RedisProxy.Builder clearSettings()
       Network settings for the connection pool to the upstream clusters.
      .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

    • getSettingsBuilder

      public RedisProxy.ConnPoolSettings.Builder getSettingsBuilder()
       Network settings for the connection pool to the upstream clusters.
      .envoy.config.filter.network.redis_proxy.v2.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

    • getSettingsOrBuilder

      public RedisProxy.ConnPoolSettingsOrBuilder getSettingsOrBuilder()
       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:
      getSettingsOrBuilder in interface RedisProxyOrBuilder

    • 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.

    • setLatencyInMicros

      public RedisProxy.Builder setLatencyInMicros(boolean value)
       Indicates that latency stat should be computed in microseconds. By default it is computed in
 milliseconds.
      bool latency_in_micros = 4;
      Parameters:
      value - The latencyInMicros to set.
      Returns:
      This builder for chaining.

    • clearLatencyInMicros

      public RedisProxy.Builder clearLatencyInMicros()
       Indicates that latency stat should be computed in microseconds. By default it is computed in
 milliseconds.
      bool latency_in_micros = 4;
      Returns:
      This builder for chaining.

    • 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.

    • setPrefixRoutes

      public RedisProxy.Builder setPrefixRoutes(RedisProxy.PrefixRoutes value)
       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;

    • setPrefixRoutes

      public RedisProxy.Builder setPrefixRoutes(RedisProxy.PrefixRoutes.Builder builderForValue)
       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;

    • mergePrefixRoutes

      public RedisProxy.Builder mergePrefixRoutes(RedisProxy.PrefixRoutes value)
       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;

    • clearPrefixRoutes

      public RedisProxy.Builder clearPrefixRoutes()
       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;

    • getPrefixRoutesBuilder

      public RedisProxy.PrefixRoutes.Builder getPrefixRoutesBuilder()
       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;

    • 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.

    • setDownstreamAuthPassword

      public RedisProxy.Builder setDownstreamAuthPassword(DataSource value)
       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];

    • setDownstreamAuthPassword

      public RedisProxy.Builder setDownstreamAuthPassword(DataSource.Builder builderForValue)
       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];

    • mergeDownstreamAuthPassword

      public RedisProxy.Builder mergeDownstreamAuthPassword(DataSource value)
       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];

    • clearDownstreamAuthPassword

      public RedisProxy.Builder clearDownstreamAuthPassword()
       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];

    • getDownstreamAuthPasswordBuilder

      public DataSource.Builder getDownstreamAuthPasswordBuilder()
       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];

    • 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

    • setUnknownFields

      public final RedisProxy.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>

    • mergeUnknownFields

      public final RedisProxy.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>