Package io.envoyproxy.envoy.api.v2.route

Class RouteAction.RequestMirrorPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.RequestMirrorPolicyOrBuilder, Serializable
    Enclosing class:
    RouteAction
    public static final class RouteAction.RequestMirrorPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RouteAction.RequestMirrorPolicyOrBuilder
     The router is capable of shadowing traffic from one cluster to another. The current
 implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to
 respond before returning the response from the primary cluster. All normal statistics are
 collected for the shadow cluster making this feature useful for testing.
 During shadowing, the host/authority header is altered such that *-shadow* is appended. This is
 useful for logging. For example, *cluster1* becomes *cluster1-shadow*.
 .. note::
   Shadowing will not be triggered if the primary cluster does not exist.
    Protobuf type envoy.api.v2.route.RouteAction.RequestMirrorPolicy
    See Also:
    Serialized Form

    • Field Detail

      • RUNTIME_KEY_FIELD_NUMBER

        public static final int RUNTIME_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUNTIME_FRACTION_FIELD_NUMBER

        public static final int RUNTIME_FRACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRACE_SAMPLED_FIELD_NUMBER

        public static final int TRACE_SAMPLED_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getCluster

        public String getCluster()
         Specifies the cluster that requests will be mirrored to. The cluster must
 exist in the cluster manager configuration.
        string cluster = 1 [(.validate.rules) = { ... }
        Specified by:
        getCluster in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The cluster.

      • 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
        Returns:
        The bytes for cluster.

      • getRuntimeKey

        @Deprecated
public String getRuntimeKey()
        Deprecated.
        envoy.api.v2.route.RouteAction.RequestMirrorPolicy.runtime_key is deprecated. See envoy/api/v2/route/route_components.proto;l=606
         If not specified, all requests to the target cluster will be mirrored. If
 specified, Envoy will lookup the runtime key to get the % of requests to
 mirror. Valid values are from 0 to 10000, allowing for increments of
 0.01% of requests to be mirrored. If the runtime key is specified in the
 configuration but not present in runtime, 0 is the default and thus 0% of
 requests will be mirrored.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`runtime_fraction
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   field instead. Mirroring occurs if both this and
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   are not set.
        string runtime_key = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getRuntimeKey in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The runtimeKey.

      • getRuntimeKeyBytes

        @Deprecated
public com.google.protobuf.ByteString getRuntimeKeyBytes()
        Deprecated.
        envoy.api.v2.route.RouteAction.RequestMirrorPolicy.runtime_key is deprecated. See envoy/api/v2/route/route_components.proto;l=606
         If not specified, all requests to the target cluster will be mirrored. If
 specified, Envoy will lookup the runtime key to get the % of requests to
 mirror. Valid values are from 0 to 10000, allowing for increments of
 0.01% of requests to be mirrored. If the runtime key is specified in the
 configuration but not present in runtime, 0 is the default and thus 0% of
 requests will be mirrored.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`runtime_fraction
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   field instead. Mirroring occurs if both this and
   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
   are not set.
        string runtime_key = 2 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getRuntimeKeyBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The bytes for runtimeKey.

      • hasRuntimeFraction

        public boolean hasRuntimeFraction()
         If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the `runtime_key` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
        .envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;
        Specified by:
        hasRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
        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.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;
        Specified by:
        getRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
        Returns:
        The runtimeFraction.

      • getRuntimeFractionOrBuilder

        public RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()
         If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the `runtime_key` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
        .envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 3;
        Specified by:
        getRuntimeFractionOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

      • hasTraceSampled

        public boolean hasTraceSampled()
         Determines if the trace span should be sampled. Defaults to true.
        .google.protobuf.BoolValue trace_sampled = 4;
        Specified by:
        hasTraceSampled in interface RouteAction.RequestMirrorPolicyOrBuilder
        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.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

        public RouteAction.RequestMirrorPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RouteAction.RequestMirrorPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RouteAction.RequestMirrorPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RouteAction.RequestMirrorPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RouteAction.RequestMirrorPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder