Class RouteAction.RequestMirrorPolicy.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
io.envoyproxy.envoy.config.route.v3.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``. This behavior can be disabled by setting ``disable_shadow_host_suffix_append`` to ``true``. .. note:: Shadowing will not be triggered if the primary cluster does not exist. .. note:: Shadowing doesn't support HTTP CONNECT and upgrades. [#next-free-field: 9]Protobuf type
envoy.config.route.v3.RouteAction.RequestMirrorPolicy-
Method Summary
Modifier and TypeMethodDescriptionaddAllRequestHeadersMutations(Iterable<? extends HeaderMutation> values) Specifies a list of header mutations that should be applied to each mirrored request.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addRequestHeadersMutations(int index, HeaderMutation value) Specifies a list of header mutations that should be applied to each mirrored request.addRequestHeadersMutations(int index, HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request.Specifies a list of header mutations that should be applied to each mirrored request.addRequestHeadersMutations(HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request.Specifies a list of header mutations that should be applied to each mirrored request.addRequestHeadersMutationsBuilder(int index) Specifies a list of header mutations that should be applied to each mirrored request.build()clear()Only one of ``cluster`` and ``cluster_header`` can be specified.Only one of ``cluster`` and ``cluster_header`` can be specified.Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) Indicates that during mirroring, the host header will be swapped with this value.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Specifies a list of header mutations that should be applied to each mirrored request.If not specified, all requests to the target cluster will be mirrored.Specifies whether the trace span for the shadow request should be sampled.clone()Only one of ``cluster`` and ``cluster_header`` can be specified.com.google.protobuf.ByteStringOnly one of ``cluster`` and ``cluster_header`` can be specified.Only one of ``cluster`` and ``cluster_header`` can be specified.com.google.protobuf.ByteStringOnly one of ``cluster`` and ``cluster_header`` can be specified.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorbooleanDisables appending the ``-shadow`` suffix to the shadowed ``Host`` header.Indicates that during mirroring, the host header will be swapped with this value.com.google.protobuf.ByteStringIndicates that during mirroring, the host header will be swapped with this value.getRequestHeadersMutations(int index) Specifies a list of header mutations that should be applied to each mirrored request.getRequestHeadersMutationsBuilder(int index) Specifies a list of header mutations that should be applied to each mirrored request.Specifies a list of header mutations that should be applied to each mirrored request.intSpecifies a list of header mutations that should be applied to each mirrored request.Specifies a list of header mutations that should be applied to each mirrored request.getRequestHeadersMutationsOrBuilder(int index) Specifies a list of header mutations that should be applied to each mirrored request.List<? extends HeaderMutationOrBuilder>Specifies a list of header mutations that should be applied to each mirrored request.If not specified, all requests to the target cluster will be mirrored.If not specified, all requests to the target cluster will be mirrored.If not specified, all requests to the target cluster will be mirrored.com.google.protobuf.BoolValueSpecifies whether the trace span for the shadow request should be sampled.com.google.protobuf.BoolValue.BuilderSpecifies whether the trace span for the shadow request should be sampled.com.google.protobuf.BoolValueOrBuilderSpecifies whether the trace span for the shadow request should be sampled.booleanIf not specified, all requests to the target cluster will be mirrored.booleanSpecifies whether the trace span for the shadow request should be sampled.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) If not specified, all requests to the target cluster will be mirrored.mergeTraceSampled(com.google.protobuf.BoolValue value) Specifies whether the trace span for the shadow request should be sampled.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeRequestHeadersMutations(int index) Specifies a list of header mutations that should be applied to each mirrored request.setCluster(String value) Only one of ``cluster`` and ``cluster_header`` can be specified.setClusterBytes(com.google.protobuf.ByteString value) Only one of ``cluster`` and ``cluster_header`` can be specified.setClusterHeader(String value) Only one of ``cluster`` and ``cluster_header`` can be specified.setClusterHeaderBytes(com.google.protobuf.ByteString value) Only one of ``cluster`` and ``cluster_header`` can be specified.setDisableShadowHostSuffixAppend(boolean value) Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header.setHostRewriteLiteral(String value) Indicates that during mirroring, the host header will be swapped with this value.setHostRewriteLiteralBytes(com.google.protobuf.ByteString value) Indicates that during mirroring, the host header will be swapped with this value.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRequestHeadersMutations(int index, HeaderMutation value) Specifies a list of header mutations that should be applied to each mirrored request.setRequestHeadersMutations(int index, HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request.If not specified, all requests to the target cluster will be mirrored.setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue) If not specified, all requests to the target cluster will be mirrored.setTraceSampled(com.google.protobuf.BoolValue value) Specifies whether the trace span for the shadow request should be sampled.setTraceSampled(com.google.protobuf.BoolValue.Builder builderForValue) Specifies whether the trace span for the shadow request should be sampled.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
setField
public RouteAction.RequestMirrorPolicy.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
clearField
public RouteAction.RequestMirrorPolicy.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
clearOneof
public RouteAction.RequestMirrorPolicy.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.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:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
addRepeatedField
public RouteAction.RequestMirrorPolicy.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RouteAction.RequestMirrorPolicy.Builder>- Throws:
IOException
-
getCluster
Only one of ``cluster`` and ``cluster_header`` can be specified. [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}] Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getClusterin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The cluster.
-
getClusterBytes
public com.google.protobuf.ByteString getClusterBytes()Only one of ``cluster`` and ``cluster_header`` can be specified. [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}] Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getClusterBytesin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The bytes for cluster.
-
setCluster
Only one of ``cluster`` and ``cluster_header`` can be specified. [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}] Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }- Parameters:
value- The cluster to set.- Returns:
- This builder for chaining.
-
clearCluster
Only one of ``cluster`` and ``cluster_header`` can be specified. [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}] Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }- Returns:
- This builder for chaining.
-
setClusterBytes
public RouteAction.RequestMirrorPolicy.Builder setClusterBytes(com.google.protobuf.ByteString value) Only one of ``cluster`` and ``cluster_header`` can be specified. [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}] Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }- Parameters:
value- The bytes for cluster to set.- Returns:
- This builder for chaining.
-
getClusterHeader
Only one of ``cluster`` and ``cluster_header`` can be specified. Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers. Only the first value in header is used, and no shadow request will happen if the value is not found in headers. Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. .. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead. .. note:: If the header appears multiple times only the first value is used.
string cluster_header = 5 [(.validate.rules) = { ... }- Specified by:
getClusterHeaderin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The clusterHeader.
-
getClusterHeaderBytes
public com.google.protobuf.ByteString getClusterHeaderBytes()Only one of ``cluster`` and ``cluster_header`` can be specified. Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers. Only the first value in header is used, and no shadow request will happen if the value is not found in headers. Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. .. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead. .. note:: If the header appears multiple times only the first value is used.
string cluster_header = 5 [(.validate.rules) = { ... }- Specified by:
getClusterHeaderBytesin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The bytes for clusterHeader.
-
setClusterHeader
Only one of ``cluster`` and ``cluster_header`` can be specified. Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers. Only the first value in header is used, and no shadow request will happen if the value is not found in headers. Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. .. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead. .. note:: If the header appears multiple times only the first value is used.
string cluster_header = 5 [(.validate.rules) = { ... }- Parameters:
value- The clusterHeader to set.- Returns:
- This builder for chaining.
-
clearClusterHeader
Only one of ``cluster`` and ``cluster_header`` can be specified. Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers. Only the first value in header is used, and no shadow request will happen if the value is not found in headers. Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. .. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead. .. note:: If the header appears multiple times only the first value is used.
string cluster_header = 5 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setClusterHeaderBytes
public RouteAction.RequestMirrorPolicy.Builder setClusterHeaderBytes(com.google.protobuf.ByteString value) Only one of ``cluster`` and ``cluster_header`` can be specified. Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers. Only the first value in header is used, and no shadow request will happen if the value is not found in headers. Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. .. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead. .. note:: If the header appears multiple times only the first value is used.
string cluster_header = 5 [(.validate.rules) = { ... }- Parameters:
value- The bytes for clusterHeader to set.- Returns:
- This builder for chaining.
-
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.v3.RuntimeFractionalPercent runtime_fraction = 3;- Specified by:
hasRuntimeFractionin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- Whether the runtimeFraction field is set.
-
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.v3.RuntimeFractionalPercent runtime_fraction = 3;- Specified by:
getRuntimeFractionin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The runtimeFraction.
-
setRuntimeFraction
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.v3.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.v3.RuntimeFractionalPercent runtime_fraction = 3; -
mergeRuntimeFraction
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.v3.RuntimeFractionalPercent runtime_fraction = 3; -
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.v3.RuntimeFractionalPercent runtime_fraction = 3; -
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.v3.RuntimeFractionalPercent runtime_fraction = 3; -
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.v3.RuntimeFractionalPercent runtime_fraction = 3;- Specified by:
getRuntimeFractionOrBuilderin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
hasTraceSampled
public boolean hasTraceSampled()Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4;- Specified by:
hasTraceSampledin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- Whether the traceSampled field is set.
-
getTraceSampled
public com.google.protobuf.BoolValue getTraceSampled()Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4;- Specified by:
getTraceSampledin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The traceSampled.
-
setTraceSampled
Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4; -
setTraceSampled
public RouteAction.RequestMirrorPolicy.Builder setTraceSampled(com.google.protobuf.BoolValue.Builder builderForValue) Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4; -
mergeTraceSampled
public RouteAction.RequestMirrorPolicy.Builder mergeTraceSampled(com.google.protobuf.BoolValue value) Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4; -
clearTraceSampled
Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4; -
getTraceSampledBuilder
public com.google.protobuf.BoolValue.Builder getTraceSampledBuilder()Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4; -
getTraceSampledOrBuilder
public com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set, the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling is disabled.
.google.protobuf.BoolValue trace_sampled = 4;- Specified by:
getTraceSampledOrBuilderin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
getDisableShadowHostSuffixAppend
public boolean getDisableShadowHostSuffixAppend()Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header. Defaults to ``false``.
bool disable_shadow_host_suffix_append = 6;- Specified by:
getDisableShadowHostSuffixAppendin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The disableShadowHostSuffixAppend.
-
setDisableShadowHostSuffixAppend
Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header. Defaults to ``false``.
bool disable_shadow_host_suffix_append = 6;- Parameters:
value- The disableShadowHostSuffixAppend to set.- Returns:
- This builder for chaining.
-
clearDisableShadowHostSuffixAppend
Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header. Defaults to ``false``.
bool disable_shadow_host_suffix_append = 6;- Returns:
- This builder for chaining.
-
getRequestHeadersMutationsList
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersMutationsListin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
getRequestHeadersMutationsCount
public int getRequestHeadersMutationsCount()Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersMutationsCountin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
getRequestHeadersMutations
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersMutationsin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
setRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder setRequestHeadersMutations(int index, HeaderMutation value) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
setRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder setRequestHeadersMutations(int index, HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addRequestHeadersMutations
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder addRequestHeadersMutations(int index, HeaderMutation value) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder addRequestHeadersMutations(HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder addRequestHeadersMutations(int index, HeaderMutation.Builder builderForValue) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addAllRequestHeadersMutations
public RouteAction.RequestMirrorPolicy.Builder addAllRequestHeadersMutations(Iterable<? extends HeaderMutation> values) Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
clearRequestHeadersMutations
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
removeRequestHeadersMutations
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
getRequestHeadersMutationsBuilder
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
getRequestHeadersMutationsOrBuilder
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersMutationsOrBuilderin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
getRequestHeadersMutationsOrBuilderList
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersMutationsOrBuilderListin interfaceRouteAction.RequestMirrorPolicyOrBuilder
-
addRequestHeadersMutationsBuilder
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
addRequestHeadersMutationsBuilder
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
getRequestHeadersMutationsBuilderList
Specifies a list of header mutations that should be applied to each mirrored request. Header mutations are applied in the order they are specified. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... } -
getHostRewriteLiteral
Indicates that during mirroring, the host header will be swapped with this value. :ref:`disable_shadow_host_suffix_append <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>` is implicitly enabled if this field is set.
string host_rewrite_literal = 8 [(.validate.rules) = { ... }- Specified by:
getHostRewriteLiteralin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The hostRewriteLiteral.
-
getHostRewriteLiteralBytes
public com.google.protobuf.ByteString getHostRewriteLiteralBytes()Indicates that during mirroring, the host header will be swapped with this value. :ref:`disable_shadow_host_suffix_append <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>` is implicitly enabled if this field is set.
string host_rewrite_literal = 8 [(.validate.rules) = { ... }- Specified by:
getHostRewriteLiteralBytesin interfaceRouteAction.RequestMirrorPolicyOrBuilder- Returns:
- The bytes for hostRewriteLiteral.
-
setHostRewriteLiteral
Indicates that during mirroring, the host header will be swapped with this value. :ref:`disable_shadow_host_suffix_append <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>` is implicitly enabled if this field is set.
string host_rewrite_literal = 8 [(.validate.rules) = { ... }- Parameters:
value- The hostRewriteLiteral to set.- Returns:
- This builder for chaining.
-
clearHostRewriteLiteral
Indicates that during mirroring, the host header will be swapped with this value. :ref:`disable_shadow_host_suffix_append <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>` is implicitly enabled if this field is set.
string host_rewrite_literal = 8 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setHostRewriteLiteralBytes
public RouteAction.RequestMirrorPolicy.Builder setHostRewriteLiteralBytes(com.google.protobuf.ByteString value) Indicates that during mirroring, the host header will be swapped with this value. :ref:`disable_shadow_host_suffix_append <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>` is implicitly enabled if this field is set.
string host_rewrite_literal = 8 [(.validate.rules) = { ... }- Parameters:
value- The bytes for hostRewriteLiteral to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final RouteAction.RequestMirrorPolicy.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-
mergeUnknownFields
public final RouteAction.RequestMirrorPolicy.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.RequestMirrorPolicy.Builder>
-