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

Class RedisProxy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3.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: 12]
Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisProxy
See Also:

  • Field Details

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • SETTINGS_FIELD_NUMBER

      public static final int SETTINGS_FIELD_NUMBER
      See Also:

    • LATENCY_IN_MICROS_FIELD_NUMBER

      public static final int LATENCY_IN_MICROS_FIELD_NUMBER
      See Also:

    • PREFIX_ROUTES_FIELD_NUMBER

      public static final int PREFIX_ROUTES_FIELD_NUMBER
      See Also:

    • DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER

      public static final int DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER
      See Also:

    • DOWNSTREAM_AUTH_PASSWORDS_FIELD_NUMBER

      public static final int DOWNSTREAM_AUTH_PASSWORDS_FIELD_NUMBER
      See Also:

    • FAULTS_FIELD_NUMBER

      public static final int FAULTS_FIELD_NUMBER
      See Also:

    • DOWNSTREAM_AUTH_USERNAME_FIELD_NUMBER

      public static final int DOWNSTREAM_AUTH_USERNAME_FIELD_NUMBER
      See Also:

    • EXTERNAL_AUTH_PROVIDER_FIELD_NUMBER

      public static final int EXTERNAL_AUTH_PROVIDER_FIELD_NUMBER
      See Also:

    • CUSTOM_COMMANDS_FIELD_NUMBER

      public static final int CUSTOM_COMMANDS_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

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

    • hasSettings

      public boolean hasSettings()
       Network settings for the connection pool to the upstream clusters.
      .envoy.extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }
      Specified by:
      getSettings in interface RedisProxyOrBuilder
      Returns:
      The settings.

    • getSettingsOrBuilder

      public RedisProxy.ConnPoolSettingsOrBuilder getSettingsOrBuilder()
       Network settings for the connection pool to the upstream clusters.
      .envoy.extensions.filters.network.redis_proxy.v3.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. This does not apply to upstream command stats currently.
      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_v3_api_field_extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.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_v3_api_field_extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.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_v3_api_field_extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.RedisProxy.PrefixRoutes prefix_routes = 5;
      Specified by:
      getPrefixRoutesOrBuilder in interface RedisProxyOrBuilder

    • hasDownstreamAuthPassword

      @Deprecated public boolean hasDownstreamAuthPassword()
      Deprecated.
      envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.downstream_auth_password is deprecated. See envoy/extensions/filters/network/redis_proxy/v3/redis_proxy.proto;l=301
       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.

 .. attention::
   This field is deprecated. Use :ref:`downstream_auth_passwords
   <envoy_v3_api_field_extensions.filters.network.redis_proxy.v3.RedisProxy.downstream_auth_passwords>`.
      .envoy.config.core.v3.DataSource downstream_auth_password = 6 [deprecated = true, (.udpa.annotations.sensitive) = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasDownstreamAuthPassword in interface RedisProxyOrBuilder
      Returns:
      Whether the downstreamAuthPassword field is set.

    • getDownstreamAuthPassword

      @Deprecated public DataSource getDownstreamAuthPassword()
      Deprecated.
      envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.downstream_auth_password is deprecated. See envoy/extensions/filters/network/redis_proxy/v3/redis_proxy.proto;l=301
       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.

 .. attention::
   This field is deprecated. Use :ref:`downstream_auth_passwords
   <envoy_v3_api_field_extensions.filters.network.redis_proxy.v3.RedisProxy.downstream_auth_passwords>`.
      .envoy.config.core.v3.DataSource downstream_auth_password = 6 [deprecated = true, (.udpa.annotations.sensitive) = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getDownstreamAuthPassword in interface RedisProxyOrBuilder
      Returns:
      The downstreamAuthPassword.

    • getDownstreamAuthPasswordOrBuilder

      @Deprecated public DataSourceOrBuilder getDownstreamAuthPasswordOrBuilder()
      Deprecated.
       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.

 .. attention::
   This field is deprecated. Use :ref:`downstream_auth_passwords
   <envoy_v3_api_field_extensions.filters.network.redis_proxy.v3.RedisProxy.downstream_auth_passwords>`.
      .envoy.config.core.v3.DataSource downstream_auth_password = 6 [deprecated = true, (.udpa.annotations.sensitive) = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getDownstreamAuthPasswordOrBuilder in interface RedisProxyOrBuilder

    • getDownstreamAuthPasswordsList

      public List<DataSource> getDownstreamAuthPasswordsList()
       Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with one of these passwords before enabling any other
 command. If an AUTH command's password matches one of these passwords, an "OK" response will be returned
 to the client. If the AUTH command password does not match, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when the
 password(s) are 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.
      repeated .envoy.config.core.v3.DataSource downstream_auth_passwords = 9 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthPasswordsList in interface RedisProxyOrBuilder

    • getDownstreamAuthPasswordsOrBuilderList

      public List<? extends DataSourceOrBuilder> getDownstreamAuthPasswordsOrBuilderList()
       Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with one of these passwords before enabling any other
 command. If an AUTH command's password matches one of these passwords, an "OK" response will be returned
 to the client. If the AUTH command password does not match, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when the
 password(s) are 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.
      repeated .envoy.config.core.v3.DataSource downstream_auth_passwords = 9 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthPasswordsOrBuilderList in interface RedisProxyOrBuilder

    • getDownstreamAuthPasswordsCount

      public int getDownstreamAuthPasswordsCount()
       Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with one of these passwords before enabling any other
 command. If an AUTH command's password matches one of these passwords, an "OK" response will be returned
 to the client. If the AUTH command password does not match, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when the
 password(s) are 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.
      repeated .envoy.config.core.v3.DataSource downstream_auth_passwords = 9 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthPasswordsCount in interface RedisProxyOrBuilder

    • getDownstreamAuthPasswords

      public DataSource getDownstreamAuthPasswords(int index)
       Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with one of these passwords before enabling any other
 command. If an AUTH command's password matches one of these passwords, an "OK" response will be returned
 to the client. If the AUTH command password does not match, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when the
 password(s) are 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.
      repeated .envoy.config.core.v3.DataSource downstream_auth_passwords = 9 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthPasswords in interface RedisProxyOrBuilder

    • getDownstreamAuthPasswordsOrBuilder

      public DataSourceOrBuilder getDownstreamAuthPasswordsOrBuilder(int index)
       Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with one of these passwords before enabling any other
 command. If an AUTH command's password matches one of these passwords, an "OK" response will be returned
 to the client. If the AUTH command password does not match, then an "ERR invalid
 password" error will be returned. If any other command is received before AUTH when the
 password(s) are 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.
      repeated .envoy.config.core.v3.DataSource downstream_auth_passwords = 9 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthPasswordsOrBuilder in interface RedisProxyOrBuilder

    • getFaultsList

      public List<RedisProxy.RedisFault> getFaultsList()
       List of faults to inject. Faults currently come in two flavors:
 - Delay, which delays a request.
 - Error, which responds to a request with an error. Errors can also have delays attached.

 Example:

 .. code-block:: yaml

    faults:
    - fault_type: ERROR
      fault_enabled:
        default_value:
          numerator: 10
          denominator: HUNDRED
        runtime_key: "bogus_key"
        commands:
        - GET
      - fault_type: DELAY
        fault_enabled:
          default_value:
            numerator: 10
            denominator: HUNDRED
          runtime_key: "bogus_key"
        delay: 2s

 See the :ref:`fault injection section
 <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.RedisFault faults = 8;
      Specified by:
      getFaultsList in interface RedisProxyOrBuilder

    • getFaultsOrBuilderList

      public List<? extends RedisProxy.RedisFaultOrBuilder> getFaultsOrBuilderList()
       List of faults to inject. Faults currently come in two flavors:
 - Delay, which delays a request.
 - Error, which responds to a request with an error. Errors can also have delays attached.

 Example:

 .. code-block:: yaml

    faults:
    - fault_type: ERROR
      fault_enabled:
        default_value:
          numerator: 10
          denominator: HUNDRED
        runtime_key: "bogus_key"
        commands:
        - GET
      - fault_type: DELAY
        fault_enabled:
          default_value:
            numerator: 10
            denominator: HUNDRED
          runtime_key: "bogus_key"
        delay: 2s

 See the :ref:`fault injection section
 <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.RedisFault faults = 8;
      Specified by:
      getFaultsOrBuilderList in interface RedisProxyOrBuilder

    • getFaultsCount

      public int getFaultsCount()
       List of faults to inject. Faults currently come in two flavors:
 - Delay, which delays a request.
 - Error, which responds to a request with an error. Errors can also have delays attached.

 Example:

 .. code-block:: yaml

    faults:
    - fault_type: ERROR
      fault_enabled:
        default_value:
          numerator: 10
          denominator: HUNDRED
        runtime_key: "bogus_key"
        commands:
        - GET
      - fault_type: DELAY
        fault_enabled:
          default_value:
            numerator: 10
            denominator: HUNDRED
          runtime_key: "bogus_key"
        delay: 2s

 See the :ref:`fault injection section
 <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.RedisFault faults = 8;
      Specified by:
      getFaultsCount in interface RedisProxyOrBuilder

    • getFaults

      public RedisProxy.RedisFault getFaults(int index)
       List of faults to inject. Faults currently come in two flavors:
 - Delay, which delays a request.
 - Error, which responds to a request with an error. Errors can also have delays attached.

 Example:

 .. code-block:: yaml

    faults:
    - fault_type: ERROR
      fault_enabled:
        default_value:
          numerator: 10
          denominator: HUNDRED
        runtime_key: "bogus_key"
        commands:
        - GET
      - fault_type: DELAY
        fault_enabled:
          default_value:
            numerator: 10
            denominator: HUNDRED
          runtime_key: "bogus_key"
        delay: 2s

 See the :ref:`fault injection section
 <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.RedisFault faults = 8;
      Specified by:
      getFaults in interface RedisProxyOrBuilder

    • getFaultsOrBuilder

      public RedisProxy.RedisFaultOrBuilder getFaultsOrBuilder(int index)
       List of faults to inject. Faults currently come in two flavors:
 - Delay, which delays a request.
 - Error, which responds to a request with an error. Errors can also have delays attached.

 Example:

 .. code-block:: yaml

    faults:
    - fault_type: ERROR
      fault_enabled:
        default_value:
          numerator: 10
          denominator: HUNDRED
        runtime_key: "bogus_key"
        commands:
        - GET
      - fault_type: DELAY
        fault_enabled:
          default_value:
            numerator: 10
            denominator: HUNDRED
          runtime_key: "bogus_key"
        delay: 2s

 See the :ref:`fault injection section
 <config_network_filters_redis_proxy_fault_injection>` for more information on how to configure this.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.RedisFault faults = 8;
      Specified by:
      getFaultsOrBuilder in interface RedisProxyOrBuilder

    • hasDownstreamAuthUsername

      public boolean hasDownstreamAuthUsername()
       If a username is provided an ACL style AUTH command will be required with a username and password.
 Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this username and the ``downstream_auth_password``
 before enabling any other command. If an AUTH command's username and password matches this username
 and the ``downstream_auth_password`` , an "OK" response will be returned to the client. If the AUTH
 command username or password does not match this username or the ``downstream_auth_password``, then an
 "WRONGPASS invalid username-password pair" 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 ACL is set" error will be returned.
      .envoy.config.core.v3.DataSource downstream_auth_username = 7 [(.udpa.annotations.sensitive) = true];
      Specified by:
      hasDownstreamAuthUsername in interface RedisProxyOrBuilder
      Returns:
      Whether the downstreamAuthUsername field is set.

    • getDownstreamAuthUsername

      public DataSource getDownstreamAuthUsername()
       If a username is provided an ACL style AUTH command will be required with a username and password.
 Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this username and the ``downstream_auth_password``
 before enabling any other command. If an AUTH command's username and password matches this username
 and the ``downstream_auth_password`` , an "OK" response will be returned to the client. If the AUTH
 command username or password does not match this username or the ``downstream_auth_password``, then an
 "WRONGPASS invalid username-password pair" 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 ACL is set" error will be returned.
      .envoy.config.core.v3.DataSource downstream_auth_username = 7 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthUsername in interface RedisProxyOrBuilder
      Returns:
      The downstreamAuthUsername.

    • getDownstreamAuthUsernameOrBuilder

      public DataSourceOrBuilder getDownstreamAuthUsernameOrBuilder()
       If a username is provided an ACL style AUTH command will be required with a username and password.
 Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis
 AUTH command <https://redis.io/commands/auth>`_ with this username and the ``downstream_auth_password``
 before enabling any other command. If an AUTH command's username and password matches this username
 and the ``downstream_auth_password`` , an "OK" response will be returned to the client. If the AUTH
 command username or password does not match this username or the ``downstream_auth_password``, then an
 "WRONGPASS invalid username-password pair" 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 ACL is set" error will be returned.
      .envoy.config.core.v3.DataSource downstream_auth_username = 7 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getDownstreamAuthUsernameOrBuilder in interface RedisProxyOrBuilder

    • hasExternalAuthProvider

      public boolean hasExternalAuthProvider()
       External authentication configuration. If set, instead of validating username and password against ``downstream_auth_username`` and ``downstream_auth_password``,
 the filter will call an external gRPC service to authenticate the client.
 A typical usage of this feature is for situations where the password is a one-time token that needs to be validated against a remote service, like a sidecar.
 Expiration is also supported, which will disable any further commands from the client after the expiration time, unless a new AUTH command is received and the external auth service returns a new expiration time.
 If the external auth service returns an error, authentication is considered failed.
 If this setting is set together with ``downstream_auth_username`` and ``downstream_auth_password``, the external auth service will be source of truth, but those fields will still be used for downstream authentication to the cluster.
 The API is defined by :ref:`RedisProxyExternalAuthRequest <envoy_v3_api_msg_service.redis_auth.v3.RedisProxyExternalAuthRequest>`.
      .envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider external_auth_provider = 10;
      Specified by:
      hasExternalAuthProvider in interface RedisProxyOrBuilder
      Returns:
      Whether the externalAuthProvider field is set.

    • getExternalAuthProvider

      public RedisExternalAuthProvider getExternalAuthProvider()
       External authentication configuration. If set, instead of validating username and password against ``downstream_auth_username`` and ``downstream_auth_password``,
 the filter will call an external gRPC service to authenticate the client.
 A typical usage of this feature is for situations where the password is a one-time token that needs to be validated against a remote service, like a sidecar.
 Expiration is also supported, which will disable any further commands from the client after the expiration time, unless a new AUTH command is received and the external auth service returns a new expiration time.
 If the external auth service returns an error, authentication is considered failed.
 If this setting is set together with ``downstream_auth_username`` and ``downstream_auth_password``, the external auth service will be source of truth, but those fields will still be used for downstream authentication to the cluster.
 The API is defined by :ref:`RedisProxyExternalAuthRequest <envoy_v3_api_msg_service.redis_auth.v3.RedisProxyExternalAuthRequest>`.
      .envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider external_auth_provider = 10;
      Specified by:
      getExternalAuthProvider in interface RedisProxyOrBuilder
      Returns:
      The externalAuthProvider.

    • getExternalAuthProviderOrBuilder

      public RedisExternalAuthProviderOrBuilder getExternalAuthProviderOrBuilder()
       External authentication configuration. If set, instead of validating username and password against ``downstream_auth_username`` and ``downstream_auth_password``,
 the filter will call an external gRPC service to authenticate the client.
 A typical usage of this feature is for situations where the password is a one-time token that needs to be validated against a remote service, like a sidecar.
 Expiration is also supported, which will disable any further commands from the client after the expiration time, unless a new AUTH command is received and the external auth service returns a new expiration time.
 If the external auth service returns an error, authentication is considered failed.
 If this setting is set together with ``downstream_auth_username`` and ``downstream_auth_password``, the external auth service will be source of truth, but those fields will still be used for downstream authentication to the cluster.
 The API is defined by :ref:`RedisProxyExternalAuthRequest <envoy_v3_api_msg_service.redis_auth.v3.RedisProxyExternalAuthRequest>`.
      .envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider external_auth_provider = 10;
      Specified by:
      getExternalAuthProviderOrBuilder in interface RedisProxyOrBuilder

    • getCustomCommandsList

      public com.google.protobuf.ProtocolStringList getCustomCommandsList()
       Optional configure redis custom commands for the proxy, eg -> ["my_custom_cmd1", "my_custom_cmd2"]

 .. note::
   The is to support redis's feature wherein new commands can be added using redis' modules api:
   https://redis.io/docs/latest/develop/reference/modules/
      repeated string custom_commands = 11;
      Specified by:
      getCustomCommandsList in interface RedisProxyOrBuilder
      Returns:
      A list containing the customCommands.

    • getCustomCommandsCount

      public int getCustomCommandsCount()
       Optional configure redis custom commands for the proxy, eg -> ["my_custom_cmd1", "my_custom_cmd2"]

 .. note::
   The is to support redis's feature wherein new commands can be added using redis' modules api:
   https://redis.io/docs/latest/develop/reference/modules/
      repeated string custom_commands = 11;
      Specified by:
      getCustomCommandsCount in interface RedisProxyOrBuilder
      Returns:
      The count of customCommands.

    • getCustomCommands

      public String getCustomCommands(int index)
       Optional configure redis custom commands for the proxy, eg -> ["my_custom_cmd1", "my_custom_cmd2"]

 .. note::
   The is to support redis's feature wherein new commands can be added using redis' modules api:
   https://redis.io/docs/latest/develop/reference/modules/
      repeated string custom_commands = 11;
      Specified by:
      getCustomCommands in interface RedisProxyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The customCommands at the given index.

    • getCustomCommandsBytes

      public com.google.protobuf.ByteString getCustomCommandsBytes(int index)
       Optional configure redis custom commands for the proxy, eg -> ["my_custom_cmd1", "my_custom_cmd2"]

 .. note::
   The is to support redis's feature wherein new commands can be added using redis' modules api:
   https://redis.io/docs/latest/develop/reference/modules/
      repeated string custom_commands = 11;
      Specified by:
      getCustomCommandsBytes in interface RedisProxyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the customCommands 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 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static RedisProxy.Builder newBuilder()

    • newBuilder

      public static RedisProxy.Builder newBuilder(RedisProxy prototype)

    • 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