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

Class RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy

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.PrefixRoutes.Route.RequestMirrorPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder, Serializable

Enclosing class:

RedisProxy.PrefixRoutes.Route

public static final class RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

 The router is capable of shadowing traffic from one cluster to another. The current
 implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to
 respond before returning the response from the primary cluster. All normal statistics are
 collected for the shadow cluster making this feature useful for testing.
 

Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	The router is capable of shadowing traffic from one cluster to another.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLUSTER_FIELD_NUMBER
static final int	EXCLUDE_READ_COMMANDS_FIELD_NUMBER
static final int	RUNTIME_FRACTION_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

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCluster()	Specifies the cluster that requests will be mirrored to.
com.google.protobuf.ByteString	getClusterBytes()	Specifies the cluster that requests will be mirrored to.
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	getDefaultInstance()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getExcludeReadCommands()	Set this to TRUE to only mirror write commands, this is effectively replicating the writes in a "fire and forget" manner.
com.google.protobuf.Parser<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy>	getParserForType()
RuntimeFractionalPercent	getRuntimeFraction()	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RuntimeFractionalPercentOrBuilder	getRuntimeFractionOrBuilder()	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
int	getSerializedSize()
int	hashCode()
boolean	hasRuntimeFraction()	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	newBuilder()
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	newBuilder(RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy prototype)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	newBuilderForType()
protected RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseDelimitedFrom(InputStream input)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(byte[] data)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(com.google.protobuf.ByteString data)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(InputStream input)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(ByteBuffer data)
static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy>	parser()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER

See Also:

• Constant Field Values

RUNTIME_FRACTION_FIELD_NUMBER

public static final int RUNTIME_FRACTION_FIELD_NUMBER

See Also:

• Constant Field Values

EXCLUDE_READ_COMMANDS_FIELD_NUMBER

public static final int EXCLUDE_READ_COMMANDS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

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

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getCluster

public String getCluster()

 Specifies the cluster that requests will be mirrored to. The cluster must
 exist in the cluster manager configuration.
 

string cluster = 1 [(.validate.rules) = { ... }

Specified by:

getCluster in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

Returns:

The cluster.

getClusterBytes

public com.google.protobuf.ByteString getClusterBytes()

 Specifies the cluster that requests will be mirrored to. The cluster must
 exist in the cluster manager configuration.
 

string cluster = 1 [(.validate.rules) = { ... }

Specified by:

getClusterBytes in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

Returns:

The bytes for cluster.

hasRuntimeFraction

public boolean hasRuntimeFraction()

 If not specified or the runtime key is not present, all requests to the target cluster
 will be mirrored.

 If specified, Envoy will lookup the runtime key to get the percentage of requests to the
 mirror.
 

.envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 2;

Specified by:

hasRuntimeFraction in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

Returns:

Whether the runtimeFraction field is set.

getRuntimeFraction

public RuntimeFractionalPercent getRuntimeFraction()

 If not specified or the runtime key is not present, all requests to the target cluster
 will be mirrored.

 If specified, Envoy will lookup the runtime key to get the percentage of requests to the
 mirror.
 

.envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 2;

Specified by:

getRuntimeFraction in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

Returns:

The runtimeFraction.

getRuntimeFractionOrBuilder

public RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()

 If not specified or the runtime key is not present, all requests to the target cluster
 will be mirrored.

 If specified, Envoy will lookup the runtime key to get the percentage of requests to the
 mirror.
 

.envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 2;

Specified by:

getRuntimeFractionOrBuilder in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

getExcludeReadCommands

public boolean getExcludeReadCommands()

 Set this to TRUE to only mirror write commands, this is effectively replicating the
 writes in a "fire and forget" manner.
 

bool exclude_read_commands = 3;

Specified by:

getExcludeReadCommands in interface RedisProxy.PrefixRoutes.Route.RequestMirrorPolicyOrBuilder

Returns:

The excludeReadCommands.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(ByteBuffer data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(com.google.protobuf.ByteString data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(byte[] data)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(InputStream input)
                                                                   throws IOException

Throws:

IOException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseDelimitedFrom(InputStream input)
                                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                            throws IOException

Throws:

IOException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                                                   throws IOException

Throws:

IOException

parseFrom

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws IOException

Throws:

IOException

newBuilderForType

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder newBuilder()

newBuilder

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder newBuilder(RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy prototype)

toBuilder

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy getDefaultInstance()

parser

public static com.google.protobuf.Parser<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy> parser()

getParserForType

public com.google.protobuf.Parser<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder