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

Class PerRouteConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.dynamic_forward_proxy.v3.PerRouteConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PerRouteConfigOrBuilder, Serializable
public final class PerRouteConfig extends com.google.protobuf.GeneratedMessageV3 implements PerRouteConfigOrBuilder
 Per route Configuration for the dynamic forward proxy HTTP filter.
Protobuf type envoy.extensions.filters.http.dynamic_forward_proxy.v3.PerRouteConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PerRouteConfig.Builder
    Per route Configuration for the dynamic forward proxy HTTP filter.
    static enum 
    PerRouteConfig.HostRewriteSpecifierCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    HOST_REWRITE_HEADER_FIELD_NUMBER
     
    static final int
    HOST_REWRITE_LITERAL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static PerRouteConfig
    getDefaultInstance()
     
    PerRouteConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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()
     
    com.google.protobuf.Parser<PerRouteConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PerRouteConfig.Builder
    newBuilder()
     
    static PerRouteConfig.Builder
    newBuilder(PerRouteConfig prototype)
     
    PerRouteConfig.Builder
    newBuilderForType()
     
    protected PerRouteConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PerRouteConfig
    parseDelimitedFrom(InputStream input)
     
    static PerRouteConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PerRouteConfig
    parseFrom(byte[] data)
     
    static PerRouteConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PerRouteConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static PerRouteConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PerRouteConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PerRouteConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PerRouteConfig
    parseFrom(InputStream input)
     
    static PerRouteConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PerRouteConfig
    parseFrom(ByteBuffer data)
     
    static PerRouteConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PerRouteConfig>
    parser()
     
    PerRouteConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • HOST_REWRITE_LITERAL_FIELD_NUMBER

      public static final int HOST_REWRITE_LITERAL_FIELD_NUMBER
      See Also:

    • HOST_REWRITE_HEADER_FIELD_NUMBER

      public static final int HOST_REWRITE_HEADER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getHostRewriteSpecifierCase

      public PerRouteConfig.HostRewriteSpecifierCase getHostRewriteSpecifierCase()
      Specified by:
      getHostRewriteSpecifierCase in interface PerRouteConfigOrBuilder

    • hasHostRewriteLiteral

      public 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;
      Specified by:
      hasHostRewriteLiteral in interface PerRouteConfigOrBuilder
      Returns:
      Whether the hostRewriteLiteral field is set.

    • getHostRewriteLiteral

      public 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;
      Specified by:
      getHostRewriteLiteral in interface PerRouteConfigOrBuilder
      Returns:
      The hostRewriteLiteral.

    • getHostRewriteLiteralBytes

      public 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;
      Specified by:
      getHostRewriteLiteralBytes in interface PerRouteConfigOrBuilder
      Returns:
      The bytes for hostRewriteLiteral.

    • hasHostRewriteHeader

      public 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;
      Specified by:
      hasHostRewriteHeader in interface PerRouteConfigOrBuilder
      Returns:
      Whether the hostRewriteHeader field is set.

    • getHostRewriteHeader

      public 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;
      Specified by:
      getHostRewriteHeader in interface PerRouteConfigOrBuilder
      Returns:
      The hostRewriteHeader.

    • getHostRewriteHeaderBytes

      public 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;
      Specified by:
      getHostRewriteHeaderBytes in interface PerRouteConfigOrBuilder
      Returns:
      The bytes for hostRewriteHeader.

    • 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 PerRouteConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static PerRouteConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PerRouteConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PerRouteConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PerRouteConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PerRouteConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PerRouteConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PerRouteConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static PerRouteConfig.Builder newBuilder()

    • newBuilder

      public static PerRouteConfig.Builder newBuilder(PerRouteConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PerRouteConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PerRouteConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<PerRouteConfig> 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 PerRouteConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder