io.envoyproxy.envoy.api.v2.route

Interface RouteAction.RequestMirrorPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RouteAction.RequestMirrorPolicy, RouteAction.RequestMirrorPolicy.Builder

Enclosing class:

RouteAction

public static interface RouteAction.RequestMirrorPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
boolean	hasRuntimeFraction() If not specified, all requests to the target cluster will be mirrored.
boolean	hasTraceSampled() Determines if the trace span should be sampled.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCluster

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

getClusterBytes

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

getRuntimeKey

@Deprecated
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];

getRuntimeKeyBytes

@Deprecated
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];

hasRuntimeFraction

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;

getRuntimeFraction

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;

getRuntimeFractionOrBuilder

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;

hasTraceSampled

boolean hasTraceSampled()

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

.google.protobuf.BoolValue trace_sampled = 4;

getTraceSampled

com.google.protobuf.BoolValue getTraceSampled()

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

.google.protobuf.BoolValue trace_sampled = 4;

getTraceSampledOrBuilder

com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()

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

.google.protobuf.BoolValue trace_sampled = 4;