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

Interface RedisProxyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RedisProxy, RedisProxy.Builder
    public interface RedisProxyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getCluster()
      Deprecated.
      envoy.config.filter.network.redis_proxy.v2.RedisProxy.cluster is deprecated.
      com.google.protobuf.ByteString getClusterBytes()
      Deprecated.
      envoy.config.filter.network.redis_proxy.v2.RedisProxy.cluster is deprecated.
      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.
      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.
      boolean getLatencyInMicros()
      Indicates that latency stat should be computed in microseconds.
      RedisProxy.PrefixRoutes getPrefixRoutes()
      List of **unique** prefixes used to separate keys from different workloads to different clusters.
      RedisProxy.PrefixRoutesOrBuilder getPrefixRoutesOrBuilder()
      List of **unique** prefixes used to separate keys from different workloads to different clusters.
      RedisProxy.ConnPoolSettings getSettings()
      Network settings for the connection pool to the upstream clusters.
      RedisProxy.ConnPoolSettingsOrBuilder getSettingsOrBuilder()
      Network settings for the connection pool to the upstream clusters.
      String getStatPrefix()
      The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
      com.google.protobuf.ByteString getStatPrefixBytes()
      The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
      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.
      boolean hasPrefixRoutes()
      List of **unique** prefixes used to separate keys from different workloads to different clusters.
      boolean hasSettings()
      Network settings for the connection pool to the upstream clusters.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getStatPrefix

        String getStatPrefix()
         The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        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) = { ... }
        Returns:
        The bytes for statPrefix.

      • getCluster

        @Deprecated
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];
        Returns:
        The cluster.

      • getClusterBytes

        @Deprecated
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];
        Returns:
        The bytes for cluster.

      • hasSettings

        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) = { ... }
        Returns:
        Whether the settings field is set.

      • getSettings

        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) = { ... }
        Returns:
        The settings.

      • getSettingsOrBuilder

        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) = { ... }

      • getLatencyInMicros

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

      • hasPrefixRoutes

        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;
        Returns:
        Whether the prefixRoutes field is set.

      • getPrefixRoutes

        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;
        Returns:
        The prefixRoutes.

      • getPrefixRoutesOrBuilder

        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;

      • hasDownstreamAuthPassword

        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];
        Returns:
        Whether the downstreamAuthPassword field is set.

      • getDownstreamAuthPassword

        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];
        Returns:
        The downstreamAuthPassword.

      • getDownstreamAuthPasswordOrBuilder

        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];