RedisProxy (api 0.1.28 API)

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: 9]
 
```
Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisProxy
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RedisProxy.Builder` [#next-free-field: 9] Protobuf type `envoy.extensions.filters.network.redis_proxy.v3.RedisProxy`
`static class`	`RedisProxy.ConnPoolSettings` Redis connection pool settings.
`static interface`	`RedisProxy.ConnPoolSettingsOrBuilder`
`static class`	`RedisProxy.PrefixRoutes` Protobuf type `envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.PrefixRoutes`
`static interface`	`RedisProxy.PrefixRoutesOrBuilder`
`static class`	`RedisProxy.RedisFault` RedisFault defines faults used for fault injection.
`static interface`	`RedisProxy.RedisFaultOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER`
`static int`	`DOWNSTREAM_AUTH_USERNAME_FIELD_NUMBER`
`static int`	`FAULTS_FIELD_NUMBER`
`static int`	`LATENCY_IN_MICROS_FIELD_NUMBER`
`static int`	`PREFIX_ROUTES_FIELD_NUMBER`
`static int`	`SETTINGS_FIELD_NUMBER`
`static int`	`STAT_PREFIX_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static RedisProxy`	`getDefaultInstance()`
`RedisProxy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`DataSource`	`getDownstreamAuthPassword()` Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other command.
`DataSourceOrBuilder`	`getDownstreamAuthPasswordOrBuilder()` Authenticate Redis client connections locally by forcing downstream clients to issue a `Redis AUTH command <https://redis.io/commands/auth>`_ with this password before enabling any other command.
`DataSource`	`getDownstreamAuthUsername()` 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.
`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.
`com.google.protobuf.Parser<RedisProxy>`	`getParserForType()`
`RedisProxy.PrefixRoutes`	`getPrefixRoutes()` List of unique prefixes used to separate keys from different workloads to different clusters.
`RedisProxy.PrefixRoutesOrBuilder`	`getPrefixRoutesOrBuilder()` List of unique prefixes used to separate keys from different workloads to different clusters.
`int`	`getSerializedSize()`
`RedisProxy.ConnPoolSettings`	`getSettings()` Network settings for the connection pool to the upstream clusters.
`RedisProxy.ConnPoolSettingsOrBuilder`	`getSettingsOrBuilder()` Network settings for the connection pool to the upstream clusters.
`String`	`getStatPrefix()` The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
`com.google.protobuf.ByteString`	`getStatPrefixBytes()` The prefix to use when emitting :ref:`statistics <config_network_filters_redis_proxy_stats>`.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`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.
`int`	`hashCode()`
`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()`
`static RedisProxy.Builder`	`newBuilder()`
`static RedisProxy.Builder`	`newBuilder(RedisProxy prototype)`
`RedisProxy.Builder`	`newBuilderForType()`
`protected RedisProxy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static RedisProxy`	`parseDelimitedFrom(InputStream input)`
`static RedisProxy`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RedisProxy`	`parseFrom(byte[] data)`
`static RedisProxy`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RedisProxy`	`parseFrom(ByteBuffer data)`
`static RedisProxy`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RedisProxy`	`parseFrom(com.google.protobuf.ByteString data)`
`static RedisProxy`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RedisProxy`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RedisProxy`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RedisProxy`	`parseFrom(InputStream input)`
`static RedisProxy`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RedisProxy>`	`parser()`
`RedisProxy.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- STAT_PREFIX_FIELD_NUMBER
```
public static final int STAT_PREFIX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SETTINGS_FIELD_NUMBER
```
public static final int SETTINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LATENCY_IN_MICROS_FIELD_NUMBER
```
public static final int LATENCY_IN_MICROS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PREFIX_ROUTES_FIELD_NUMBER
```
public static final int PREFIX_ROUTES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER
```
public static final int DOWNSTREAM_AUTH_PASSWORD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FAULTS_FIELD_NUMBER
```
public static final int FAULTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOWNSTREAM_AUTH_USERNAME_FIELD_NUMBER
```
public static final int DOWNSTREAM_AUTH_USERNAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

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

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

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

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

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

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