RedisProxy.Builder (api 0.1.28 API)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedisProxy.Builder`	`addAllFaults(Iterable<? extends RedisProxy.RedisFault> values)` List of faults to inject.
`RedisProxy.Builder`	`addFaults(int index, RedisProxy.RedisFault.Builder builderForValue)` List of faults to inject.
`RedisProxy.Builder`	`addFaults(int index, RedisProxy.RedisFault value)` List of faults to inject.
`RedisProxy.Builder`	`addFaults(RedisProxy.RedisFault.Builder builderForValue)` List of faults to inject.
`RedisProxy.Builder`	`addFaults(RedisProxy.RedisFault value)` List of faults to inject.
`RedisProxy.RedisFault.Builder`	`addFaultsBuilder()` List of faults to inject.
`RedisProxy.RedisFault.Builder`	`addFaultsBuilder(int index)` List of faults to inject.
`RedisProxy.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RedisProxy`	`build()`
`RedisProxy`	`buildPartial()`
`RedisProxy.Builder`	`clear()`
`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.
`RedisProxy.Builder`	`clearDownstreamAuthUsername()` If a username is provided an ACL style AUTH command will be required with a username and password.
`RedisProxy.Builder`	`clearFaults()` List of faults to inject.
`RedisProxy.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RedisProxy.Builder`	`clearLatencyInMicros()` Indicates that latency stat should be computed in microseconds.
`RedisProxy.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RedisProxy.Builder`	`clearPrefixRoutes()` List of unique prefixes used to separate keys from different workloads to different clusters.
`RedisProxy.Builder`	`clearSettings()` Network settings for the connection pool to the upstream clusters.
`RedisProxy.Builder`	`clearStatPrefix()` The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
`RedisProxy.Builder`	`clone()`
`RedisProxy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`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.
`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.
`DataSource`	`getDownstreamAuthUsername()` If a username is provided an ACL style AUTH command will be required with a username and password.
`DataSource.Builder`	`getDownstreamAuthUsernameBuilder()` If a username is provided an ACL style AUTH command will be required with a username and password.
`DataSourceOrBuilder`	`getDownstreamAuthUsernameOrBuilder()` If a username is provided an ACL style AUTH command will be required with a username and password.
`RedisProxy.RedisFault`	`getFaults(int index)` List of faults to inject.
`RedisProxy.RedisFault.Builder`	`getFaultsBuilder(int index)` List of faults to inject.
`List<RedisProxy.RedisFault.Builder>`	`getFaultsBuilderList()` List of faults to inject.
`int`	`getFaultsCount()` List of faults to inject.
`List<RedisProxy.RedisFault>`	`getFaultsList()` List of faults to inject.
`RedisProxy.RedisFaultOrBuilder`	`getFaultsOrBuilder(int index)` List of faults to inject.
`List<? extends RedisProxy.RedisFaultOrBuilder>`	`getFaultsOrBuilderList()` List of faults to inject.
`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.PrefixRoutes.Builder`	`getPrefixRoutesBuilder()` 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.ConnPoolSettings.Builder`	`getSettingsBuilder()` 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`	`hasDownstreamAuthUsername()` If a username is provided an ACL style AUTH command will be required with a username and password.
`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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`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.
`RedisProxy.Builder`	`mergeDownstreamAuthUsername(DataSource value)` If a username is provided an ACL style AUTH command will be required with a username and password.
`RedisProxy.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RedisProxy.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RedisProxy.Builder`	`mergeFrom(RedisProxy other)`
`RedisProxy.Builder`	`mergePrefixRoutes(RedisProxy.PrefixRoutes value)` List of unique prefixes used to separate keys from different workloads to different clusters.
`RedisProxy.Builder`	`mergeSettings(RedisProxy.ConnPoolSettings value)` Network settings for the connection pool to the upstream clusters.
`RedisProxy.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RedisProxy.Builder`	`removeFaults(int index)` List of faults to inject.
`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.
`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.
`RedisProxy.Builder`	`setDownstreamAuthUsername(DataSource.Builder builderForValue)` If a username is provided an ACL style AUTH command will be required with a username and password.
`RedisProxy.Builder`	`setDownstreamAuthUsername(DataSource value)` If a username is provided an ACL style AUTH command will be required with a username and password.
`RedisProxy.Builder`	`setFaults(int index, RedisProxy.RedisFault.Builder builderForValue)` List of faults to inject.
`RedisProxy.Builder`	`setFaults(int index, RedisProxy.RedisFault value)` List of faults to inject.
`RedisProxy.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RedisProxy.Builder`	`setLatencyInMicros(boolean value)` Indicates that latency stat should be computed in microseconds.
`RedisProxy.Builder`	`setPrefixRoutes(RedisProxy.PrefixRoutes.Builder builderForValue)` List of unique prefixes used to separate keys from different workloads to different clusters.
`RedisProxy.Builder`	`setPrefixRoutes(RedisProxy.PrefixRoutes value)` List of unique prefixes used to separate keys from different workloads to different clusters.
`RedisProxy.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RedisProxy.Builder`	`setSettings(RedisProxy.ConnPoolSettings.Builder builderForValue)` Network settings for the connection pool to the upstream clusters.
`RedisProxy.Builder`	`setSettings(RedisProxy.ConnPoolSettings value)` Network settings for the connection pool to the upstream clusters.
`RedisProxy.Builder`	`setStatPrefix(String value)` The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
`RedisProxy.Builder`	`setStatPrefixBytes(com.google.protobuf.ByteString value)` The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
`RedisProxy.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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

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

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

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

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

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

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

setSettings

public RedisProxy.Builder setSettings(RedisProxy.ConnPoolSettings value)

 Network settings for the connection pool to the upstream clusters.

.envoy.extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.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.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

clearSettings
```
public RedisProxy.Builder clearSettings()
```
```
 Network settings for the connection pool to the upstream clusters.
 
```
.envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

getSettingsBuilder

public RedisProxy.ConnPoolSettings.Builder getSettingsBuilder()

 Network settings for the connection pool to the upstream clusters.

.envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings settings = 3 [(.validate.rules) = { ... }

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

setLatencyInMicros

public RedisProxy.Builder setLatencyInMicros(boolean value)

 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;

clearLatencyInMicros

public RedisProxy.Builder clearLatencyInMicros()

 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;

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_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

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_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

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

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

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

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

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

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_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

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.config.core.v3.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];

Specified by:: hasDownstreamAuthPassword in interface RedisProxyOrBuilder

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.config.core.v3.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];

Specified by:: getDownstreamAuthPassword in interface RedisProxyOrBuilder

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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.DataSource downstream_auth_password = 6 [(.udpa.annotations.sensitive) = true];

Specified by:: getDownstreamAuthPasswordOrBuilder in interface RedisProxyOrBuilder