Package io.envoyproxy.envoy.config.route.v3

Class 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, java.lang.Cloneable
    Enclosing class:
    RouteAction.RequestMirrorPolicy
    public static final class RouteAction.RequestMirrorPolicy.Builder
extends com.google.protobuf.GeneratedMessage.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: 7]
    Protobuf type envoy.config.route.v3.RouteAction.RequestMirrorPolicy

    • Field Detail

      • bitField0_

        private int bitField0_

      • cluster_

        private java.lang.Object cluster_

      • clusterHeader_

        private java.lang.Object clusterHeader_

      • traceSampled_

        private com.google.protobuf.BoolValue traceSampled_

      • traceSampledBuilder_

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue,​com.google.protobuf.BoolValue.Builder,​com.google.protobuf.BoolValueOrBuilder> traceSampledBuilder_

      • disableShadowHostSuffixAppend_

        private boolean disableShadowHostSuffixAppend_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RouteAction.RequestMirrorPolicy.Builder>

      • maybeForceBuilderInitialization

        private void maybeForceBuilderInitialization()

      • 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.GeneratedMessage.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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RouteAction.RequestMirrorPolicy.Builder>

      • mergeFrom

        public RouteAction.RequestMirrorPolicy.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.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:
        java.io.IOException

      • getCluster

        public java.lang.String 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:
        getCluster in interface RouteAction.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:
        getClusterBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The bytes for cluster.

      • setCluster

        public RouteAction.RequestMirrorPolicy.Builder setCluster​(java.lang.String 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 cluster to set.
        Returns:
        This builder for chaining.

      • clearCluster

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

        public java.lang.String 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:
        getClusterHeader in interface RouteAction.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:
        getClusterHeaderBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The bytes for clusterHeader.

      • setClusterHeader

        public RouteAction.RequestMirrorPolicy.Builder setClusterHeader​(java.lang.String 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 clusterHeader to set.
        Returns:
        This builder for chaining.

      • clearClusterHeader

        public RouteAction.RequestMirrorPolicy.Builder 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:
        hasRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        Whether the runtimeFraction field is set.

      • 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.v3.RuntimeFractionalPercent runtime_fraction = 3;
        Specified by:
        getRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The runtimeFraction.

      • 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.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

        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.v3.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.v3.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.v3.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.v3.RuntimeFractionalPercent runtime_fraction = 3;
        Specified by:
        getRuntimeFractionOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

      • getRuntimeFractionFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,​RuntimeFractionalPercent.Builder,​RuntimeFractionalPercentOrBuilder> getRuntimeFractionFieldBuilder()
         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;

      • 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
        Returns:
        Whether the traceSampled field is set.

      • 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
        Returns:
        The traceSampled.

      • 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;

      • getTraceSampledFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue,​com.google.protobuf.BoolValue.Builder,​com.google.protobuf.BoolValueOrBuilder> getTraceSampledFieldBuilder()
         Determines if the trace span should be sampled. Defaults to true.
        .google.protobuf.BoolValue trace_sampled = 4;

      • 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:
        getDisableShadowHostSuffixAppend in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The disableShadowHostSuffixAppend.

      • setDisableShadowHostSuffixAppend

        public RouteAction.RequestMirrorPolicy.Builder setDisableShadowHostSuffixAppend​(boolean value)
         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

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