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

Interface RouteAction.RequestMirrorPolicyOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCluster()
      Only one of ``cluster`` and ``cluster_header`` can be specified.
      com.google.protobuf.ByteString getClusterBytes()
      Only one of ``cluster`` and ``cluster_header`` can be specified.
      String getClusterHeader()
      Only one of ``cluster`` and ``cluster_header`` can be specified.
      com.google.protobuf.ByteString getClusterHeaderBytes()
      Only one of ``cluster`` and ``cluster_header`` can be specified.
      RuntimeFractionalPercent getRuntimeFraction()
      If not specified, all requests to the target cluster will be mirrored.
      RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()
      If not specified, all requests to the target cluster will be mirrored.
      com.google.protobuf.BoolValue getTraceSampled()
      Determines if the trace span should be sampled.
      com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()
      Determines if the trace span should be sampled.
      boolean hasRuntimeFraction()
      If not specified, all requests to the target cluster will be mirrored.
      boolean hasTraceSampled()
      Determines if the trace span should be sampled.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getCluster

        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) = { ... }
        Returns:
        The cluster.

      • getClusterBytes

        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) = { ... }
        Returns:
        The bytes for cluster.

      • getClusterHeader

        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) = { ... }
        Returns:
        The clusterHeader.

      • getClusterHeaderBytes

        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) = { ... }
        Returns:
        The bytes for clusterHeader.

      • hasRuntimeFraction

        boolean hasRuntimeFraction()
         If not specified, all requests to the target cluster will be mirrored.
 If specified, this field takes precedence over the ``runtime_key`` field and requests must also
 fall under the percentage of matches indicated by this field.
 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
        .envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 3;
        Returns:
        Whether the runtimeFraction field is set.

      • getRuntimeFraction

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

      • getRuntimeFractionOrBuilder

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

      • hasTraceSampled

        boolean hasTraceSampled()
         Determines if the trace span should be sampled. Defaults to true.
        .google.protobuf.BoolValue trace_sampled = 4;
        Returns:
        Whether the traceSampled field is set.

      • getTraceSampled

        com.google.protobuf.BoolValue getTraceSampled()
         Determines if the trace span should be sampled. Defaults to true.
        .google.protobuf.BoolValue trace_sampled = 4;
        Returns:
        The traceSampled.

      • getTraceSampledOrBuilder

        com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()
         Determines if the trace span should be sampled. Defaults to true.
        .google.protobuf.BoolValue trace_sampled = 4;