Package io.envoyproxy.envoy.api.v2.route

Interface VirtualClusterOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      HeaderMatcher getHeaders​(int index)
      Specifies a list of header matchers to use for matching requests.
      int getHeadersCount()
      Specifies a list of header matchers to use for matching requests.
      List<HeaderMatcher> getHeadersList()
      Specifies a list of header matchers to use for matching requests.
      HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
      Specifies a list of header matchers to use for matching requests.
      List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
      Specifies a list of header matchers to use for matching requests.
      RequestMethod getMethod()
      Deprecated.
      envoy.api.v2.route.VirtualCluster.method is deprecated.
      int getMethodValue()
      Deprecated.
      envoy.api.v2.route.VirtualCluster.method is deprecated.
      String getName()
      Specifies the name of the virtual cluster.
      com.google.protobuf.ByteString getNameBytes()
      Specifies the name of the virtual cluster.
      String getPattern()
      Deprecated.
      envoy.api.v2.route.VirtualCluster.pattern is deprecated.
      com.google.protobuf.ByteString getPatternBytes()
      Deprecated.
      envoy.api.v2.route.VirtualCluster.pattern is deprecated.

      • 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

      • getPattern

        @Deprecated
String getPattern()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.pattern is deprecated. See envoy/api/v2/route/route_components.proto;l=1328
         Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.
        string pattern = 1 [deprecated = true, (.validate.rules) = { ... }
        Returns:
        The pattern.

      • getPatternBytes

        @Deprecated
com.google.protobuf.ByteString getPatternBytes()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.pattern is deprecated. See envoy/api/v2/route/route_components.proto;l=1328
         Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``/rides/\d+`` matches the path */rides/0*
 * The regex ``/rides/\d+`` matches the path */rides/123*
 * The regex ``/rides/\d+`` does not match the path */rides/123/456*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.
        string pattern = 1 [deprecated = true, (.validate.rules) = { ... }
        Returns:
        The bytes for pattern.

      • getHeadersList

        List<HeaderMatcher> getHeadersList()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;

      • getHeaders

        HeaderMatcher getHeaders​(int index)
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;

      • getHeadersCount

        int getHeadersCount()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;

      • getHeadersOrBuilderList

        List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;

      • getHeadersOrBuilder

        HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;

      • getName

        String getName()
         Specifies the name of the virtual cluster. The virtual cluster name as well
 as the virtual host name are used when emitting statistics. The statistics are emitted by the
 router filter and are documented :ref:`here <config_http_filters_router_stats>`.
        string name = 2 [(.validate.rules) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Specifies the name of the virtual cluster. The virtual cluster name as well
 as the virtual host name are used when emitting statistics. The statistics are emitted by the
 router filter and are documented :ref:`here <config_http_filters_router_stats>`.
        string name = 2 [(.validate.rules) = { ... }
        Returns:
        The bytes for name.

      • getMethodValue

        @Deprecated
int getMethodValue()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.method is deprecated. See envoy/api/v2/route/route_components.proto;l=1349
         Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 .. attention::
   This field has been deprecated in favor of `headers`.
        .envoy.api.v2.core.RequestMethod method = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Returns:
        The enum numeric value on the wire for method.

      • getMethod

        @Deprecated
RequestMethod getMethod()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.method is deprecated. See envoy/api/v2/route/route_components.proto;l=1349
         Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 .. attention::
   This field has been deprecated in favor of `headers`.
        .envoy.api.v2.core.RequestMethod method = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Returns:
        The method.