Package io.envoyproxy.envoy.extensions.filters.http.dynamic_forward_proxy.v3

Interface PerRouteConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PerRouteConfig, PerRouteConfig.Builder
public interface PerRouteConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHostRewriteHeader()
    Indicates that before DNS lookup, the host header will be swapped with the value of this header.
    com.google.protobuf.ByteString
    getHostRewriteHeaderBytes()
    Indicates that before DNS lookup, the host header will be swapped with the value of this header.
    String
    getHostRewriteLiteral()
    Indicates that before DNS lookup, the host header will be swapped with this value.
    com.google.protobuf.ByteString
    getHostRewriteLiteralBytes()
    Indicates that before DNS lookup, the host header will be swapped with this value.
    PerRouteConfig.HostRewriteSpecifierCase
    getHostRewriteSpecifierCase()
     
    boolean
    hasHostRewriteHeader()
    Indicates that before DNS lookup, the host header will be swapped with the value of this header.
    boolean
    hasHostRewriteLiteral()
    Indicates that before DNS lookup, the host header will be swapped with this value.

    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 Details

    • hasHostRewriteLiteral

      boolean hasHostRewriteLiteral()
       Indicates that before DNS lookup, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.
      string host_rewrite_literal = 1;
      Returns:
      Whether the hostRewriteLiteral field is set.

    • getHostRewriteLiteral

      String getHostRewriteLiteral()
       Indicates that before DNS lookup, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.
      string host_rewrite_literal = 1;
      Returns:
      The hostRewriteLiteral.

    • getHostRewriteLiteralBytes

      com.google.protobuf.ByteString getHostRewriteLiteralBytes()
       Indicates that before DNS lookup, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.
      string host_rewrite_literal = 1;
      Returns:
      The bytes for hostRewriteLiteral.

    • hasHostRewriteHeader

      boolean hasHostRewriteHeader()
       Indicates that before DNS lookup, the host header will be swapped with
 the value of this header. If not set or empty, the original host header
 value will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.

 .. note::

   If the header appears multiple times only the first value is used.
      string host_rewrite_header = 2;
      Returns:
      Whether the hostRewriteHeader field is set.

    • getHostRewriteHeader

      String getHostRewriteHeader()
       Indicates that before DNS lookup, the host header will be swapped with
 the value of this header. If not set or empty, the original host header
 value will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.

 .. note::

   If the header appears multiple times only the first value is used.
      string host_rewrite_header = 2;
      Returns:
      The hostRewriteHeader.

    • getHostRewriteHeaderBytes

      com.google.protobuf.ByteString getHostRewriteHeaderBytes()
       Indicates that before DNS lookup, the host header will be swapped with
 the value of this header. If not set or empty, the original host header
 value will be used and no rewrite will happen.

 .. note::

   This rewrite affects both DNS lookup and host header forwarding. However, this option shouldn't be used with
   :ref:`HCM host rewrite header <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>` given that
   the value set here would be used for DNS lookups whereas the value set in the HCM would be used for host
   header forwarding which might not be the desired outcome.

 .. note::

   If the header appears multiple times only the first value is used.
      string host_rewrite_header = 2;
      Returns:
      The bytes for hostRewriteHeader.

    • getHostRewriteSpecifierCase

      PerRouteConfig.HostRewriteSpecifierCase getHostRewriteSpecifierCase()