Class RouteAction.RequestMirrorPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.RequestMirrorPolicyOrBuilder, java.io.Serializable
    Enclosing class:
    RouteAction

    public static final class RouteAction.RequestMirrorPolicy
    extends com.google.protobuf.GeneratedMessage
    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
    See Also:
    Serialized Form
    • Field Detail

      • bitField0_

        private int bitField0_
      • cluster_

        private volatile java.lang.Object cluster_
      • CLUSTER_HEADER_FIELD_NUMBER

        public static final int CLUSTER_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • clusterHeader_

        private volatile java.lang.Object clusterHeader_
      • 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
      • traceSampled_

        private com.google.protobuf.BoolValue traceSampled_
      • DISABLE_SHADOW_HOST_SUFFIX_APPEND_FIELD_NUMBER

        public static final int DISABLE_SHADOW_HOST_SUFFIX_APPEND_FIELD_NUMBER
        See Also:
        Constant Field Values
      • disableShadowHostSuffixAppend_

        private boolean disableShadowHostSuffixAppend_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • RequestMirrorPolicy

        private RequestMirrorPolicy​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • RequestMirrorPolicy

        private RequestMirrorPolicy()
    • 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
      • 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.
      • 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.
      • 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.
      • 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
      • 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.
      • 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.
      • isInitialized

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

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(java.nio.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
      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(java.io.InputStream input)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(java.io.InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RouteAction.RequestMirrorPolicy parseDelimitedFrom​(java.io.InputStream input)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RouteAction.RequestMirrorPolicy parseDelimitedFrom​(java.io.InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(com.google.protobuf.CodedInputStream input)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RouteAction.RequestMirrorPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

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