public static final class RedisProxy.ConnPoolSettings extends com.google.protobuf.GeneratedMessageV3 implements RedisProxy.ConnPoolSettingsOrBuilder
Redis connection pool settings. [#next-free-field: 9]Protobuf type
envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings| Modifier and Type | Class and Description |
|---|---|
static class |
RedisProxy.ConnPoolSettings.Builder
Redis connection pool settings.
|
static class |
RedisProxy.ConnPoolSettings.ReadPolicy
ReadPolicy controls how Envoy routes read commands to Redis nodes.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
BUFFER_FLUSH_TIMEOUT_FIELD_NUMBER |
static int |
ENABLE_COMMAND_STATS_FIELD_NUMBER |
static int |
ENABLE_HASHTAGGING_FIELD_NUMBER |
static int |
ENABLE_REDIRECTION_FIELD_NUMBER |
static int |
MAX_BUFFER_SIZE_BEFORE_FLUSH_FIELD_NUMBER |
static int |
MAX_UPSTREAM_UNKNOWN_CONNECTIONS_FIELD_NUMBER |
static int |
OP_TIMEOUT_FIELD_NUMBER |
static int |
READ_POLICY_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
com.google.protobuf.Duration |
getBufferFlushTimeout()
The encoded request buffer is flushed N milliseconds after the first request has been
encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`.
|
com.google.protobuf.DurationOrBuilder |
getBufferFlushTimeoutOrBuilder()
The encoded request buffer is flushed N milliseconds after the first request has been
encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`.
|
static RedisProxy.ConnPoolSettings |
getDefaultInstance() |
RedisProxy.ConnPoolSettings |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEnableCommandStats()
Enable per-command statistics per upstream cluster, in addition to the filter level aggregate
count.
|
boolean |
getEnableHashtagging()
Use hash tagging on every redis key to guarantee that keys with the same hash tag will be
forwarded to the same upstream.
|
boolean |
getEnableRedirection()
Accept `moved and ask redirection
<https://redis.io/topics/cluster-spec#redirection-and-resharding>`_ errors from upstream
redis servers, and retry commands to the specified target server.
|
int |
getMaxBufferSizeBeforeFlush()
Maximum size of encoded request buffer before flush is triggered and encoded requests
are sent upstream.
|
com.google.protobuf.UInt32Value |
getMaxUpstreamUnknownConnections()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts
can be created at any given time by any given worker thread (see `enable_redirection` for
more details).
|
com.google.protobuf.UInt32ValueOrBuilder |
getMaxUpstreamUnknownConnectionsOrBuilder()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts
can be created at any given time by any given worker thread (see `enable_redirection` for
more details).
|
com.google.protobuf.Duration |
getOpTimeout()
Per-operation timeout in milliseconds.
|
com.google.protobuf.DurationOrBuilder |
getOpTimeoutOrBuilder()
Per-operation timeout in milliseconds.
|
com.google.protobuf.Parser<RedisProxy.ConnPoolSettings> |
getParserForType() |
RedisProxy.ConnPoolSettings.ReadPolicy |
getReadPolicy()
Read policy.
|
int |
getReadPolicyValue()
Read policy.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasBufferFlushTimeout()
The encoded request buffer is flushed N milliseconds after the first request has been
encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`.
|
int |
hashCode() |
boolean |
hasMaxUpstreamUnknownConnections()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts
can be created at any given time by any given worker thread (see `enable_redirection` for
more details).
|
boolean |
hasOpTimeout()
Per-operation timeout in milliseconds.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RedisProxy.ConnPoolSettings.Builder |
newBuilder() |
static RedisProxy.ConnPoolSettings.Builder |
newBuilder(RedisProxy.ConnPoolSettings prototype) |
RedisProxy.ConnPoolSettings.Builder |
newBuilderForType() |
protected RedisProxy.ConnPoolSettings.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RedisProxy.ConnPoolSettings |
parseDelimitedFrom(InputStream input) |
static RedisProxy.ConnPoolSettings |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RedisProxy.ConnPoolSettings |
parseFrom(byte[] data) |
static RedisProxy.ConnPoolSettings |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RedisProxy.ConnPoolSettings |
parseFrom(ByteBuffer data) |
static RedisProxy.ConnPoolSettings |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RedisProxy.ConnPoolSettings |
parseFrom(com.google.protobuf.ByteString data) |
static RedisProxy.ConnPoolSettings |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RedisProxy.ConnPoolSettings |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RedisProxy.ConnPoolSettings |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RedisProxy.ConnPoolSettings |
parseFrom(InputStream input) |
static RedisProxy.ConnPoolSettings |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RedisProxy.ConnPoolSettings> |
parser() |
RedisProxy.ConnPoolSettings.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int OP_TIMEOUT_FIELD_NUMBER
public static final int ENABLE_HASHTAGGING_FIELD_NUMBER
public static final int ENABLE_REDIRECTION_FIELD_NUMBER
public static final int MAX_BUFFER_SIZE_BEFORE_FLUSH_FIELD_NUMBER
public static final int BUFFER_FLUSH_TIMEOUT_FIELD_NUMBER
public static final int MAX_UPSTREAM_UNKNOWN_CONNECTIONS_FIELD_NUMBER
public static final int ENABLE_COMMAND_STATS_FIELD_NUMBER
public static final int READ_POLICY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasOpTimeout()
Per-operation timeout in milliseconds. The timer starts when the first command of a pipeline is written to the backend connection. Each response received from Redis resets the timer since it signifies that the next command is being processed by the backend. The only exception to this behavior is when a connection to a backend is not yet established. In that case, the connect timeout on the cluster will govern the timeout until the connection is ready.
.google.protobuf.Duration op_timeout = 1 [(.validate.rules) = { ... }hasOpTimeout in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.Duration getOpTimeout()
Per-operation timeout in milliseconds. The timer starts when the first command of a pipeline is written to the backend connection. Each response received from Redis resets the timer since it signifies that the next command is being processed by the backend. The only exception to this behavior is when a connection to a backend is not yet established. In that case, the connect timeout on the cluster will govern the timeout until the connection is ready.
.google.protobuf.Duration op_timeout = 1 [(.validate.rules) = { ... }getOpTimeout in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.DurationOrBuilder getOpTimeoutOrBuilder()
Per-operation timeout in milliseconds. The timer starts when the first command of a pipeline is written to the backend connection. Each response received from Redis resets the timer since it signifies that the next command is being processed by the backend. The only exception to this behavior is when a connection to a backend is not yet established. In that case, the connect timeout on the cluster will govern the timeout until the connection is ready.
.google.protobuf.Duration op_timeout = 1 [(.validate.rules) = { ... }getOpTimeoutOrBuilder in interface RedisProxy.ConnPoolSettingsOrBuilderpublic boolean getEnableHashtagging()
Use hash tagging on every redis key to guarantee that keys with the same hash tag will be
forwarded to the same upstream. The hash key used for determining the upstream in a
consistent hash ring configuration will be computed from the hash tagged key instead of the
whole key. The algorithm used to compute the hash tag is identical to the `redis-cluster
implementation <https://redis.io/topics/cluster-spec#keys-hash-tags>`_.
Examples:
* '{user1000}.following' and '{user1000}.followers' **will** be sent to the same upstream
* '{user1000}.following' and '{user1001}.following' **might** be sent to the same upstream
bool enable_hashtagging = 2;getEnableHashtagging in interface RedisProxy.ConnPoolSettingsOrBuilderpublic boolean getEnableRedirection()
Accept `moved and ask redirection <https://redis.io/topics/cluster-spec#redirection-and-resharding>`_ errors from upstream redis servers, and retry commands to the specified target server. The target server does not need to be known to the cluster manager. If the command cannot be redirected, then the original error is passed downstream unchanged. By default, this support is not enabled.
bool enable_redirection = 3;getEnableRedirection in interface RedisProxy.ConnPoolSettingsOrBuilderpublic int getMaxBufferSizeBeforeFlush()
Maximum size of encoded request buffer before flush is triggered and encoded requests are sent upstream. If this is unset, the buffer flushes whenever it receives data and performs no batching. This feature makes it possible for multiple clients to send requests to Envoy and have them batched- for example if one is running several worker processes, each with its own Redis connection. There is no benefit to using this with a single downstream process. Recommended size (if enabled) is 1024 bytes.
uint32 max_buffer_size_before_flush = 4;getMaxBufferSizeBeforeFlush in interface RedisProxy.ConnPoolSettingsOrBuilderpublic boolean hasBufferFlushTimeout()
The encoded request buffer is flushed N milliseconds after the first request has been encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`. If `max_buffer_size_before_flush` is not set, this flush timer is not used. Otherwise, the timer should be set according to the number of clients, overall request rate and desired maximum latency for a single command. For example, if there are many requests being batched together at a high rate, the buffer will likely be filled before the timer fires. Alternatively, if the request rate is lower the buffer will not be filled as often before the timer fires. If `max_buffer_size_before_flush` is set, but `buffer_flush_timeout` is not, the latter defaults to 3ms.
.google.protobuf.Duration buffer_flush_timeout = 5;hasBufferFlushTimeout in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.Duration getBufferFlushTimeout()
The encoded request buffer is flushed N milliseconds after the first request has been encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`. If `max_buffer_size_before_flush` is not set, this flush timer is not used. Otherwise, the timer should be set according to the number of clients, overall request rate and desired maximum latency for a single command. For example, if there are many requests being batched together at a high rate, the buffer will likely be filled before the timer fires. Alternatively, if the request rate is lower the buffer will not be filled as often before the timer fires. If `max_buffer_size_before_flush` is set, but `buffer_flush_timeout` is not, the latter defaults to 3ms.
.google.protobuf.Duration buffer_flush_timeout = 5;getBufferFlushTimeout in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.DurationOrBuilder getBufferFlushTimeoutOrBuilder()
The encoded request buffer is flushed N milliseconds after the first request has been encoded, unless the buffer size has already exceeded `max_buffer_size_before_flush`. If `max_buffer_size_before_flush` is not set, this flush timer is not used. Otherwise, the timer should be set according to the number of clients, overall request rate and desired maximum latency for a single command. For example, if there are many requests being batched together at a high rate, the buffer will likely be filled before the timer fires. Alternatively, if the request rate is lower the buffer will not be filled as often before the timer fires. If `max_buffer_size_before_flush` is set, but `buffer_flush_timeout` is not, the latter defaults to 3ms.
.google.protobuf.Duration buffer_flush_timeout = 5;getBufferFlushTimeoutOrBuilder in interface RedisProxy.ConnPoolSettingsOrBuilderpublic boolean hasMaxUpstreamUnknownConnections()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts can be created at any given time by any given worker thread (see `enable_redirection` for more details). If the host is unknown and a connection cannot be created due to enforcing this limit, then redirection will fail and the original redirection error will be passed downstream unchanged. This limit defaults to 100.
.google.protobuf.UInt32Value max_upstream_unknown_connections = 6;hasMaxUpstreamUnknownConnections in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.UInt32Value getMaxUpstreamUnknownConnections()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts can be created at any given time by any given worker thread (see `enable_redirection` for more details). If the host is unknown and a connection cannot be created due to enforcing this limit, then redirection will fail and the original redirection error will be passed downstream unchanged. This limit defaults to 100.
.google.protobuf.UInt32Value max_upstream_unknown_connections = 6;getMaxUpstreamUnknownConnections in interface RedisProxy.ConnPoolSettingsOrBuilderpublic com.google.protobuf.UInt32ValueOrBuilder getMaxUpstreamUnknownConnectionsOrBuilder()
`max_upstream_unknown_connections` controls how many upstream connections to unknown hosts can be created at any given time by any given worker thread (see `enable_redirection` for more details). If the host is unknown and a connection cannot be created due to enforcing this limit, then redirection will fail and the original redirection error will be passed downstream unchanged. This limit defaults to 100.
.google.protobuf.UInt32Value max_upstream_unknown_connections = 6;getMaxUpstreamUnknownConnectionsOrBuilder in interface RedisProxy.ConnPoolSettingsOrBuilderpublic boolean getEnableCommandStats()
Enable per-command statistics per upstream cluster, in addition to the filter level aggregate count. These commands are measured in microseconds.
bool enable_command_stats = 8;getEnableCommandStats in interface RedisProxy.ConnPoolSettingsOrBuilderpublic int getReadPolicyValue()
Read policy. The default is to read from the primary.
.envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings.ReadPolicy read_policy = 7 [(.validate.rules) = { ... }getReadPolicyValue in interface RedisProxy.ConnPoolSettingsOrBuilderpublic RedisProxy.ConnPoolSettings.ReadPolicy getReadPolicy()
Read policy. The default is to read from the primary.
.envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.ConnPoolSettings.ReadPolicy read_policy = 7 [(.validate.rules) = { ... }getReadPolicy in interface RedisProxy.ConnPoolSettingsOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RedisProxy.ConnPoolSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(InputStream input) throws IOException
IOExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RedisProxy.ConnPoolSettings parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RedisProxy.ConnPoolSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RedisProxy.ConnPoolSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RedisProxy.ConnPoolSettings.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RedisProxy.ConnPoolSettings.Builder newBuilder()
public static RedisProxy.ConnPoolSettings.Builder newBuilder(RedisProxy.ConnPoolSettings prototype)
public RedisProxy.ConnPoolSettings.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RedisProxy.ConnPoolSettings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RedisProxy.ConnPoolSettings getDefaultInstance()
public static com.google.protobuf.Parser<RedisProxy.ConnPoolSettings> parser()
public com.google.protobuf.Parser<RedisProxy.ConnPoolSettings> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RedisProxy.ConnPoolSettings getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.