Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.v3

Interface RouteMatchOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RouteMatch, RouteMatch.Builder
    public interface RouteMatchOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      HeaderMatcher getHeaders​(int index)
      Specifies a set of headers that the route should match on.
      int getHeadersCount()
      Specifies a set of headers that the route should match on.
      List<HeaderMatcher> getHeadersList()
      Specifies a set of headers that the route should match on.
      HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
      Specifies a set of headers that the route should match on.
      List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
      Specifies a set of headers that the route should match on.
      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.
      RouteMatch.MatchSpecifierCase getMatchSpecifierCase()  
      String getMethodName()
      If specified, the route must exactly match the request method name.
      com.google.protobuf.ByteString getMethodNameBytes()
      If specified, the route must exactly match the request method name.
      String getServiceName()
      If specified, the route must have the service name as the request method name prefix.
      com.google.protobuf.ByteString getServiceNameBytes()
      If specified, the route must have the service name as the request method name prefix.
      boolean hasMethodName()
      If specified, the route must exactly match the request method name.
      boolean hasServiceName()
      If specified, the route must have the service name as the request method name prefix.

      • 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

      • hasMethodName

        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;
        Returns:
        Whether the methodName field is set.

      • getMethodName

        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;
        Returns:
        The methodName.

      • getMethodNameBytes

        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;
        Returns:
        The bytes for methodName.

      • hasServiceName

        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;
        Returns:
        Whether the serviceName field is set.

      • getServiceName

        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;
        Returns:
        The serviceName.

      • getServiceNameBytes

        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;
        Returns:
        The bytes for serviceName.

      • getInvert

        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;
        Returns:
        The invert.

      • getHeadersList

        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;

      • getHeaders

        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;

      • getHeadersCount

        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;

      • getHeadersOrBuilderList

        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;

      • getHeadersOrBuilder

        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;