io.envoyproxy.envoy.api.v2.route.VirtualClusterOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-api Show documentation
envoy-api
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/api/v2/route/route_components.proto

package io.envoyproxy.envoy.api.v2.route;

public interface VirtualClusterOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.api.v2.route.VirtualCluster)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @deprecated envoy.api.v2.route.VirtualCluster.pattern is deprecated.
   *     See envoy/api/v2/route/route_components.proto;l=1329
   * @return The pattern.
   */
  @java.lang.Deprecated java.lang.String getPattern();
  /**
   *    * 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) = { ... }
   * @deprecated envoy.api.v2.route.VirtualCluster.pattern is deprecated.
   *     See envoy/api/v2/route/route_components.proto;l=1329
   * @return The bytes for pattern.
   */
  @java.lang.Deprecated com.google.protobuf.ByteString
      getPatternBytes();

  /**
   *    * 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;
   */
  java.util.List 
      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;
   */
  io.envoyproxy.envoy.api.v2.route.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  io.envoyproxy.envoy.api.v2.route.HeaderMatcherOrBuilder getHeadersOrBuilder(
      int index);

  /**
   *    * 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) = { ... }
   * @return The name.
   */
  java.lang.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) = { ... }
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * 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];
   * @deprecated envoy.api.v2.route.VirtualCluster.method is deprecated.
   *     See envoy/api/v2/route/route_components.proto;l=1350
   * @return The enum numeric value on the wire for method.
   */
  @java.lang.Deprecated int getMethodValue();
  /**
   *    * 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];
   * @deprecated envoy.api.v2.route.VirtualCluster.method is deprecated.
   *     See envoy/api/v2/route/route_components.proto;l=1350
   * @return The method.
   */
  @java.lang.Deprecated io.envoyproxy.envoy.api.v2.core.RequestMethod getMethod();
}