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

Class 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:
    Serialized Form

    • Nested Class Summary

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

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int HOST_REWRITE_HEADER_FIELD_NUMBER  
      static 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

    • Field Detail

      • HOST_REWRITE_LITERAL_FIELD_NUMBER

        public static final int HOST_REWRITE_LITERAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOST_REWRITE_HEADER_FIELD_NUMBER

        public static final int HOST_REWRITE_HEADER_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

      • 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 <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` 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 is not 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 <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` 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 is not 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 <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` 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 is not 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 is not 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 is not 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 is not 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​(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

      • 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