Class RouteMatch

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteMatchOrBuilder, Serializable

    public final class RouteMatch
    extends com.google.protobuf.GeneratedMessageV3
    implements RouteMatchOrBuilder
    Protobuf type envoy.extensions.filters.network.thrift_proxy.v3.RouteMatch
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RouteMatch.Builder
      Protobuf type envoy.extensions.filters.network.thrift_proxy.v3.RouteMatch
      static class  RouteMatch.MatchSpecifierCase  
      • 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 HEADERS_FIELD_NUMBER  
      static int INVERT_FIELD_NUMBER  
      static int METHOD_NAME_FIELD_NUMBER  
      static int SERVICE_NAME_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 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
      • hasMethodName

        public boolean hasMethodName()
         If specified, the route must exactly match the request method name. As a special case, an
         empty string matches any request method name.
         
        string method_name = 1;
        Specified by:
        hasMethodName in interface RouteMatchOrBuilder
        Returns:
        Whether the methodName field is set.
      • getMethodName

        public String getMethodName()
         If specified, the route must exactly match the request method name. As a special case, an
         empty string matches any request method name.
         
        string method_name = 1;
        Specified by:
        getMethodName in interface RouteMatchOrBuilder
        Returns:
        The methodName.
      • getMethodNameBytes

        public com.google.protobuf.ByteString getMethodNameBytes()
         If specified, the route must exactly match the request method name. As a special case, an
         empty string matches any request method name.
         
        string method_name = 1;
        Specified by:
        getMethodNameBytes in interface RouteMatchOrBuilder
        Returns:
        The bytes for methodName.
      • hasServiceName

        public boolean hasServiceName()
         If specified, the route must have the service name as the request method name prefix. As a
         special case, an empty string matches any service name. Only relevant when service
         multiplexing.
         
        string service_name = 2;
        Specified by:
        hasServiceName in interface RouteMatchOrBuilder
        Returns:
        Whether the serviceName field is set.
      • getServiceName

        public String getServiceName()
         If specified, the route must have the service name as the request method name prefix. As a
         special case, an empty string matches any service name. Only relevant when service
         multiplexing.
         
        string service_name = 2;
        Specified by:
        getServiceName in interface RouteMatchOrBuilder
        Returns:
        The serviceName.
      • getServiceNameBytes

        public com.google.protobuf.ByteString getServiceNameBytes()
         If specified, the route must have the service name as the request method name prefix. As a
         special case, an empty string matches any service name. Only relevant when service
         multiplexing.
         
        string service_name = 2;
        Specified by:
        getServiceNameBytes in interface RouteMatchOrBuilder
        Returns:
        The bytes for serviceName.
      • getInvert

        public boolean getInvert()
         Inverts whatever matching is done in the :ref:`method_name
         <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.RouteMatch.method_name>` or
         :ref:`service_name
         <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.RouteMatch.service_name>` fields.
         Cannot be combined with wildcard matching as that would result in routes never being matched.
         .. note::
           This does not invert matching done as part of the :ref:`headers field
           <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.RouteMatch.headers>` field. To
           invert header matching, see :ref:`invert_match
           <envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match>`.
         
        bool invert = 3;
        Specified by:
        getInvert in interface RouteMatchOrBuilder
        Returns:
        The invert.
      • getHeadersList

        public List<HeaderMatcher> getHeadersList()
         Specifies a set of headers that the route should match on. The router will check the request’s
         headers against all the specified headers in the route config. A match will happen if all the
         headers in the route are present in the request with the same values (or based on presence if
         the value field is not in the config). Note that this only applies for Thrift transports and/or
         protocols that support headers.
         
        repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersList in interface RouteMatchOrBuilder
      • getHeadersOrBuilderList

        public List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
         Specifies a set of headers that the route should match on. The router will check the request’s
         headers against all the specified headers in the route config. A match will happen if all the
         headers in the route are present in the request with the same values (or based on presence if
         the value field is not in the config). Note that this only applies for Thrift transports and/or
         protocols that support headers.
         
        repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersOrBuilderList in interface RouteMatchOrBuilder
      • getHeadersCount

        public int getHeadersCount()
         Specifies a set of headers that the route should match on. The router will check the request’s
         headers against all the specified headers in the route config. A match will happen if all the
         headers in the route are present in the request with the same values (or based on presence if
         the value field is not in the config). Note that this only applies for Thrift transports and/or
         protocols that support headers.
         
        repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersCount in interface RouteMatchOrBuilder
      • getHeaders

        public HeaderMatcher getHeaders​(int index)
         Specifies a set of headers that the route should match on. The router will check the request’s
         headers against all the specified headers in the route config. A match will happen if all the
         headers in the route are present in the request with the same values (or based on presence if
         the value field is not in the config). Note that this only applies for Thrift transports and/or
         protocols that support headers.
         
        repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeaders in interface RouteMatchOrBuilder
      • getHeadersOrBuilder

        public HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
         Specifies a set of headers that the route should match on. The router will check the request’s
         headers against all the specified headers in the route config. A match will happen if all the
         headers in the route are present in the request with the same values (or based on presence if
         the value field is not in the config). Note that this only applies for Thrift transports and/or
         protocols that support headers.
         
        repeated .envoy.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersOrBuilder in interface RouteMatchOrBuilder
      • 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 RouteMatch parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static RouteMatch parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static RouteMatch parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected RouteMatch.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static RouteMatch getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<RouteMatch> parser()
      • getParserForType

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