io.envoyproxy.envoy.api.v2.route

Class RouteAction.RequestMirrorPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.route.RouteAction.RequestMirrorPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.RequestMirrorPolicyOrBuilder, Serializable

Enclosing class:

RouteAction

public static final class RouteAction.RequestMirrorPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RouteAction.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.
 During shadowing, the host/authority header is altered such that *-shadow* is appended. This is
 useful for logging. For example, *cluster1* becomes *cluster1-shadow*.
 .. note::
   Shadowing will not be triggered if the primary cluster does not exist.
 

Protobuf type envoy.api.v2.route.RouteAction.RequestMirrorPolicy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteAction.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<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	CLUSTER_FIELD_NUMBER
static int	RUNTIME_FRACTION_FIELD_NUMBER
static int	RUNTIME_KEY_FIELD_NUMBER
static int	TRACE_SAMPLED_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 and 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 RouteAction.RequestMirrorPolicy	getDefaultInstance()
RouteAction.RequestMirrorPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RouteAction.RequestMirrorPolicy>	getParserForType()
RuntimeFractionalPercent	getRuntimeFraction() If not specified, all requests to the target cluster will be mirrored.
RuntimeFractionalPercentOrBuilder	getRuntimeFractionOrBuilder() If not specified, all requests to the target cluster will be mirrored.
String	getRuntimeKey() Deprecated.
com.google.protobuf.ByteString	getRuntimeKeyBytes() Deprecated.
int	getSerializedSize()
com.google.protobuf.BoolValue	getTraceSampled() Determines if the trace span should be sampled.
com.google.protobuf.BoolValueOrBuilder	getTraceSampledOrBuilder() Determines if the trace span should be sampled.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasRuntimeFraction() If not specified, all requests to the target cluster will be mirrored.
boolean	hasTraceSampled() Determines if the trace span should be sampled.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RouteAction.RequestMirrorPolicy.Builder	newBuilder()
static RouteAction.RequestMirrorPolicy.Builder	newBuilder(RouteAction.RequestMirrorPolicy prototype)
RouteAction.RequestMirrorPolicy.Builder	newBuilderForType()
protected RouteAction.RequestMirrorPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RouteAction.RequestMirrorPolicy	parseDelimitedFrom(InputStream input)
static RouteAction.RequestMirrorPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.RequestMirrorPolicy	parseFrom(byte[] data)
static RouteAction.RequestMirrorPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.RequestMirrorPolicy	parseFrom(ByteBuffer data)
static RouteAction.RequestMirrorPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.RequestMirrorPolicy	parseFrom(com.google.protobuf.ByteString data)
static RouteAction.RequestMirrorPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.RequestMirrorPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static RouteAction.RequestMirrorPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteAction.RequestMirrorPolicy	parseFrom(InputStream input)
static RouteAction.RequestMirrorPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RouteAction.RequestMirrorPolicy>	parser()
RouteAction.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, 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

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER

See Also:

Constant Field Values

RUNTIME_KEY_FIELD_NUMBER

public static final int RUNTIME_KEY_FIELD_NUMBER

See Also:

Constant Field Values

RUNTIME_FRACTION_FIELD_NUMBER

public static final int RUNTIME_FRACTION_FIELD_NUMBER

See Also:

Constant Field Values

TRACE_SAMPLED_FIELD_NUMBER

public static final int TRACE_SAMPLED_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

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 RouteAction.RequestMirrorPolicyOrBuilder

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 RouteAction.RequestMirrorPolicyOrBuilder

getRuntimeKey

@Deprecated
public String getRuntimeKey()

Deprecated.

 If not specified, all requests to the target cluster will be mirrored. If
 specified, Envoy will lookup the runtime key to get the % of requests to
 mirror. Valid values are from 0 to 10000, allowing for increments of
 0.01% of requests to be mirrored. If the runtime key is specified in the
 configuration but not present in runtime, 0 is the default and thus 0% of
 requests will be mirrored.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`runtime_fraction
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   field instead. Mirroring occurs if both this and
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   are not set.
 

string runtime_key = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

Specified by:

getRuntimeKey in interface RouteAction.RequestMirrorPolicyOrBuilder

getRuntimeKeyBytes

@Deprecated
public com.google.protobuf.ByteString getRuntimeKeyBytes()

Deprecated.

 If not specified, all requests to the target cluster will be mirrored. If
 specified, Envoy will lookup the runtime key to get the % of requests to
 mirror. Valid values are from 0 to 10000, allowing for increments of
 0.01% of requests to be mirrored. If the runtime key is specified in the
 configuration but not present in runtime, 0 is the default and thus 0% of
 requests will be mirrored.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`runtime_fraction
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   field instead. Mirroring occurs if both this and
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   are not set.
 

string runtime_key = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

Specified by:

getRuntimeKeyBytes in interface RouteAction.RequestMirrorPolicyOrBuilder

hasRuntimeFraction

public boolean hasRuntimeFraction()

 If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the `runtime_key` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
 

.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;

Specified by:

hasRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder

getRuntimeFraction

public RuntimeFractionalPercent getRuntimeFraction()

 If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the `runtime_key` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
 

.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;

Specified by:

getRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder

getRuntimeFractionOrBuilder

public RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()

 If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the `runtime_key` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
 

.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;

Specified by:

getRuntimeFractionOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

hasTraceSampled

public boolean hasTraceSampled()

 Determines if the trace span should be sampled. Defaults to true.
 

.google.protobuf.BoolValue trace_sampled = 4;

Specified by:

hasTraceSampled in interface RouteAction.RequestMirrorPolicyOrBuilder

getTraceSampled

public com.google.protobuf.BoolValue getTraceSampled()

 Determines if the trace span should be sampled. Defaults to true.
 

.google.protobuf.BoolValue trace_sampled = 4;

Specified by:

getTraceSampled in interface RouteAction.RequestMirrorPolicyOrBuilder

getTraceSampledOrBuilder

public com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()

 Determines if the trace span should be sampled. Defaults to true.
 

.google.protobuf.BoolValue trace_sampled = 4;

Specified by:

getTraceSampledOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

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 RouteAction.RequestMirrorPolicy parseFrom(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteAction.RequestMirrorPolicy parseFrom(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteAction.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 RouteAction.RequestMirrorPolicy parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteAction.RequestMirrorPolicy parseFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RouteAction.RequestMirrorPolicy parseDelimitedFrom(InputStream input)
                                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static RouteAction.RequestMirrorPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RouteAction.RequestMirrorPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RouteAction.RequestMirrorPolicy.Builder newBuilder()

newBuilder

public static RouteAction.RequestMirrorPolicy.Builder newBuilder(RouteAction.RequestMirrorPolicy prototype)

toBuilder

public RouteAction.RequestMirrorPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RouteAction.RequestMirrorPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RouteAction.RequestMirrorPolicy getDefaultInstance()

parser

public static com.google.protobuf.Parser<RouteAction.RequestMirrorPolicy> parser()

getParserForType

public com.google.protobuf.Parser<RouteAction.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 RouteAction.RequestMirrorPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder