io.envoyproxy.envoy.config.route.v4alpha

Class RouteAction.RequestMirrorPolicy.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>

io.envoyproxy.envoy.config.route.v4alpha.RouteAction.RequestMirrorPolicy.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.RequestMirrorPolicyOrBuilder, Cloneable

Enclosing class:

RouteAction.RequestMirrorPolicy

public static final class RouteAction.RequestMirrorPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
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.config.route.v4alpha.RouteAction.RequestMirrorPolicy

Method Summary

Modifier and Type	Method and Description
RouteAction.RequestMirrorPolicy.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RouteAction.RequestMirrorPolicy	build()
RouteAction.RequestMirrorPolicy	buildPartial()
RouteAction.RequestMirrorPolicy.Builder	clear()
RouteAction.RequestMirrorPolicy.Builder	clearCluster() Specifies the cluster that requests will be mirrored to.
RouteAction.RequestMirrorPolicy.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RouteAction.RequestMirrorPolicy.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RouteAction.RequestMirrorPolicy.Builder	clearRuntimeFraction() If not specified, all requests to the target cluster will be mirrored.
RouteAction.RequestMirrorPolicy.Builder	clearTraceSampled() Determines if the trace span should be sampled.
RouteAction.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.
RouteAction.RequestMirrorPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RuntimeFractionalPercent	getRuntimeFraction() If not specified, all requests to the target cluster will be mirrored.
RuntimeFractionalPercent.Builder	getRuntimeFractionBuilder() 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.
com.google.protobuf.BoolValue	getTraceSampled() Determines if the trace span should be sampled.
com.google.protobuf.BoolValue.Builder	getTraceSampledBuilder() Determines if the trace span should be sampled.
com.google.protobuf.BoolValueOrBuilder	getTraceSampledOrBuilder() Determines if the trace span should be sampled.
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()
RouteAction.RequestMirrorPolicy.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RouteAction.RequestMirrorPolicy.Builder	mergeFrom(com.google.protobuf.Message other)
RouteAction.RequestMirrorPolicy.Builder	mergeFrom(RouteAction.RequestMirrorPolicy other)
RouteAction.RequestMirrorPolicy.Builder	mergeRuntimeFraction(RuntimeFractionalPercent value) If not specified, all requests to the target cluster will be mirrored.
RouteAction.RequestMirrorPolicy.Builder	mergeTraceSampled(com.google.protobuf.BoolValue value) Determines if the trace span should be sampled.
RouteAction.RequestMirrorPolicy.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RouteAction.RequestMirrorPolicy.Builder	setCluster(String value) Specifies the cluster that requests will be mirrored to.
RouteAction.RequestMirrorPolicy.Builder	setClusterBytes(com.google.protobuf.ByteString value) Specifies the cluster that requests will be mirrored to.
RouteAction.RequestMirrorPolicy.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RouteAction.RequestMirrorPolicy.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RouteAction.RequestMirrorPolicy.Builder	setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue) If not specified, all requests to the target cluster will be mirrored.
RouteAction.RequestMirrorPolicy.Builder	setRuntimeFraction(RuntimeFractionalPercent value) If not specified, all requests to the target cluster will be mirrored.
RouteAction.RequestMirrorPolicy.Builder	setTraceSampled(com.google.protobuf.BoolValue.Builder builderForValue) Determines if the trace span should be sampled.
RouteAction.RequestMirrorPolicy.Builder	setTraceSampled(com.google.protobuf.BoolValue value) Determines if the trace span should be sampled.
RouteAction.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, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

addAll, addAll, 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.MessageOrBuilder

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

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

mergeFrom

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<RouteAction.RequestMirrorPolicy.Builder>

clear

public RouteAction.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<RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

getDefaultInstanceForType

public RouteAction.RequestMirrorPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RouteAction.RequestMirrorPolicy build()

Specified by:

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

Specified by:

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

buildPartial

public RouteAction.RequestMirrorPolicy buildPartial()

Specified by:

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

Specified by:

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

clone

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

setField

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

clearField

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

clearOneof

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

setRepeatedField

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

addRepeatedField

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

mergeFrom

public RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

mergeFrom

public RouteAction.RequestMirrorPolicy.Builder mergeFrom(RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

mergeFrom

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

setCluster

public RouteAction.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) = { ... }

clearCluster

public RouteAction.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) = { ... }

setClusterBytes

public RouteAction.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) = { ... }

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.config.core.v4alpha.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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

Specified by:

getRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder

setRuntimeFraction

public RouteAction.RequestMirrorPolicy.Builder setRuntimeFraction(RuntimeFractionalPercent value)

 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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

setRuntimeFraction

public RouteAction.RequestMirrorPolicy.Builder setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue)

 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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

mergeRuntimeFraction

public RouteAction.RequestMirrorPolicy.Builder mergeRuntimeFraction(RuntimeFractionalPercent value)

 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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

clearRuntimeFraction

public RouteAction.RequestMirrorPolicy.Builder clearRuntimeFraction()

 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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

getRuntimeFractionBuilder

public RuntimeFractionalPercent.Builder getRuntimeFractionBuilder()

 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.config.core.v4alpha.RuntimeFractionalPercent runtime_fraction = 3;

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.config.core.v4alpha.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

setTraceSampled

public RouteAction.RequestMirrorPolicy.Builder setTraceSampled(com.google.protobuf.BoolValue value)

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

.google.protobuf.BoolValue trace_sampled = 4;

setTraceSampled

public RouteAction.RequestMirrorPolicy.Builder setTraceSampled(com.google.protobuf.BoolValue.Builder builderForValue)

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

.google.protobuf.BoolValue trace_sampled = 4;

mergeTraceSampled

public RouteAction.RequestMirrorPolicy.Builder mergeTraceSampled(com.google.protobuf.BoolValue value)

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

.google.protobuf.BoolValue trace_sampled = 4;

clearTraceSampled

public RouteAction.RequestMirrorPolicy.Builder clearTraceSampled()

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

.google.protobuf.BoolValue trace_sampled = 4;

getTraceSampledBuilder

public com.google.protobuf.BoolValue.Builder getTraceSampledBuilder()

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

.google.protobuf.BoolValue trace_sampled = 4;

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

setUnknownFields

public final RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>

mergeUnknownFields

public final RouteAction.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<RouteAction.RequestMirrorPolicy.Builder>