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| Modifier and Type | Method and Description |
|---|---|
RedisProxy.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RedisProxy |
build() |
RedisProxy |
buildPartial() |
RedisProxy.Builder |
clear() |
RedisProxy.Builder |
clearCluster()
Deprecated.
|
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 |
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() |
String |
getCluster()
Deprecated.
|
com.google.protobuf.ByteString |
getClusterBytes()
Deprecated.
|
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.
|
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 |
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 |
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 |
setCluster(String value)
Deprecated.
|
RedisProxy.Builder |
setClusterBytes(com.google.protobuf.ByteString value)
Deprecated.
|
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 |
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) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RedisProxy build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RedisProxy buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RedisProxy.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.Builder>public RedisProxy.Builder mergeFrom(RedisProxy other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public RedisProxy.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.Builder>IOExceptionpublic String getStatPrefix()
The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
string stat_prefix = 1 [(.validate.rules) = { ... }getStatPrefix in interface RedisProxyOrBuilderpublic 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) = { ... }getStatPrefixBytes in interface RedisProxyOrBuilderpublic 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) = { ... }public RedisProxy.Builder clearStatPrefix()
The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
string stat_prefix = 1 [(.validate.rules) = { ... }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) = { ... }@Deprecated public String getCluster()
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];getCluster in interface RedisProxyOrBuilder@Deprecated public com.google.protobuf.ByteString getClusterBytes()
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];getClusterBytes in interface RedisProxyOrBuilder@Deprecated public RedisProxy.Builder setCluster(String value)
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];@Deprecated public RedisProxy.Builder clearCluster()
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];@Deprecated public RedisProxy.Builder setClusterBytes(com.google.protobuf.ByteString value)
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];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) = { ... }hasSettings in interface RedisProxyOrBuilderpublic 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) = { ... }getSettings in interface RedisProxyOrBuilderpublic 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) = { ... }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) = { ... }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) = { ... }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) = { ... }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) = { ... }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) = { ... }getSettingsOrBuilder in interface RedisProxyOrBuilderpublic boolean getLatencyInMicros()
Indicates that latency stat should be computed in microseconds. By default it is computed in milliseconds.
bool latency_in_micros = 4;getLatencyInMicros in interface RedisProxyOrBuilderpublic 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;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;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;hasPrefixRoutes in interface RedisProxyOrBuilderpublic 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;getPrefixRoutes in interface RedisProxyOrBuilderpublic 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;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;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;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;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;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;getPrefixRoutesOrBuilder in interface RedisProxyOrBuilderpublic 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];hasDownstreamAuthPassword in interface RedisProxyOrBuilderpublic 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];getDownstreamAuthPassword in interface RedisProxyOrBuilderpublic 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];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];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];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];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];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];getDownstreamAuthPasswordOrBuilder in interface RedisProxyOrBuilderpublic final RedisProxy.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>public final RedisProxy.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.