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

Class RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3.RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder

All Implemented Interfaces:

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

Enclosing class:

RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy

public static final class RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>
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

Method Summary

Modifier and Type	Method	Description
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	build()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	buildPartial()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clear()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clearCluster()	Specifies the cluster that requests will be mirrored to.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clearExcludeReadCommands()	Set this to TRUE to only mirror write commands, this is effectively replicating the writes in a "fire and forget" manner.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clearRuntimeFraction()	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	clone()
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.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getExcludeReadCommands()	Set this to TRUE to only mirror write commands, this is effectively replicating the writes in a "fire and forget" manner.
RuntimeFractionalPercent	getRuntimeFraction()	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RuntimeFractionalPercent.Builder	getRuntimeFractionBuilder()	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.
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()
boolean	isInitialized()
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	mergeFrom(com.google.protobuf.Message other)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	mergeFrom(RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy other)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	mergeRuntimeFraction(RuntimeFractionalPercent value)	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setCluster(String value)	Specifies the cluster that requests will be mirrored to.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setClusterBytes(com.google.protobuf.ByteString value)	Specifies the cluster that requests will be mirrored to.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setExcludeReadCommands(boolean value)	Set this to TRUE to only mirror write commands, this is effectively replicating the writes in a "fire and forget" manner.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setRuntimeFraction(RuntimeFractionalPercent value)	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue)	If not specified or the runtime key is not present, all requests to the target cluster will be mirrored.
RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

clear

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

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

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

build

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

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

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

setField

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

clearField

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

clearOneof

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

setRepeatedField

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                  int index,
                                                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

addRepeatedField

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

mergeFrom

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

mergeFrom

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder mergeFrom(RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

Throws:

IOException

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.

setCluster

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setCluster(String value)

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

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

Parameters:

value - The cluster to set.

Returns:

This builder for chaining.

clearCluster

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

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

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

Returns:

This builder for chaining.

setClusterBytes

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setClusterBytes(com.google.protobuf.ByteString value)

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

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

Parameters:

value - The bytes for cluster to set.

Returns:

This builder for chaining.

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.

setRuntimeFraction

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setRuntimeFraction(RuntimeFractionalPercent value)

 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;

setRuntimeFraction

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue)

 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;

mergeRuntimeFraction

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder mergeRuntimeFraction(RuntimeFractionalPercent value)

 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;

clearRuntimeFraction

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

 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;

getRuntimeFractionBuilder

public RuntimeFractionalPercent.Builder getRuntimeFractionBuilder()

 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;

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.

setExcludeReadCommands

public RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setExcludeReadCommands(boolean value)

 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;

Parameters:

value - The excludeReadCommands to set.

Returns:

This builder for chaining.

clearExcludeReadCommands

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

 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;

Returns:

This builder for chaining.

setUnknownFields

public final RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>

mergeUnknownFields

public final RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisProxy.PrefixRoutes.Route.RequestMirrorPolicy.Builder>