Interface RouterOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Router, Router.Builder

    public interface RouterOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • hasDynamicStats

        boolean hasDynamicStats()
         Whether the router generates dynamic cluster statistics. Defaults to
         true. Can be disabled in high performance scenarios.
         
        .google.protobuf.BoolValue dynamic_stats = 1;
        Returns:
        Whether the dynamicStats field is set.
      • getDynamicStats

        com.google.protobuf.BoolValue getDynamicStats()
         Whether the router generates dynamic cluster statistics. Defaults to
         true. Can be disabled in high performance scenarios.
         
        .google.protobuf.BoolValue dynamic_stats = 1;
        Returns:
        The dynamicStats.
      • getDynamicStatsOrBuilder

        com.google.protobuf.BoolValueOrBuilder getDynamicStatsOrBuilder()
         Whether the router generates dynamic cluster statistics. Defaults to
         true. Can be disabled in high performance scenarios.
         
        .google.protobuf.BoolValue dynamic_stats = 1;
      • getStartChildSpan

        @Deprecated
        boolean getStartChildSpan()
        Deprecated.
        envoy.extensions.filters.http.router.v3.Router.start_child_span is deprecated. See envoy/extensions/filters/http/router/v3/router.proto;l=60
         Whether to start a child span for egress routed calls. This can be
         useful in scenarios where other filters (auth, ratelimit, etc.) make
         outbound calls and have child spans rooted at the same ingress
         parent. Defaults to false.
        
         .. attention::
         This field is deprecated by the
         :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`.
         Please use that ``spawn_upstream_span`` field to control the span creation.
         
        bool start_child_span = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The startChildSpan.
      • getUpstreamLogList

        java.util.List<AccessLog> getUpstreamLogList()
         Configuration for HTTP upstream logs emitted by the router. Upstream logs
         are configured in the same way as access logs, but each log entry represents
         an upstream request. Presuming retries are configured, multiple upstream
         requests may be made for each downstream (inbound) request.
         
        repeated .envoy.config.accesslog.v3.AccessLog upstream_log = 3;
      • getUpstreamLog

        AccessLog getUpstreamLog​(int index)
         Configuration for HTTP upstream logs emitted by the router. Upstream logs
         are configured in the same way as access logs, but each log entry represents
         an upstream request. Presuming retries are configured, multiple upstream
         requests may be made for each downstream (inbound) request.
         
        repeated .envoy.config.accesslog.v3.AccessLog upstream_log = 3;
      • getUpstreamLogCount

        int getUpstreamLogCount()
         Configuration for HTTP upstream logs emitted by the router. Upstream logs
         are configured in the same way as access logs, but each log entry represents
         an upstream request. Presuming retries are configured, multiple upstream
         requests may be made for each downstream (inbound) request.
         
        repeated .envoy.config.accesslog.v3.AccessLog upstream_log = 3;
      • getUpstreamLogOrBuilderList

        java.util.List<? extends AccessLogOrBuilder> getUpstreamLogOrBuilderList()
         Configuration for HTTP upstream logs emitted by the router. Upstream logs
         are configured in the same way as access logs, but each log entry represents
         an upstream request. Presuming retries are configured, multiple upstream
         requests may be made for each downstream (inbound) request.
         
        repeated .envoy.config.accesslog.v3.AccessLog upstream_log = 3;
      • getUpstreamLogOrBuilder

        AccessLogOrBuilder getUpstreamLogOrBuilder​(int index)
         Configuration for HTTP upstream logs emitted by the router. Upstream logs
         are configured in the same way as access logs, but each log entry represents
         an upstream request. Presuming retries are configured, multiple upstream
         requests may be made for each downstream (inbound) request.
         
        repeated .envoy.config.accesslog.v3.AccessLog upstream_log = 3;
      • hasUpstreamLogOptions

        boolean hasUpstreamLogOptions()
         Additional upstream access log options.
         
        .envoy.extensions.filters.http.router.v3.Router.UpstreamAccessLogOptions upstream_log_options = 9;
        Returns:
        Whether the upstreamLogOptions field is set.
      • getUpstreamLogOptions

        Router.UpstreamAccessLogOptions getUpstreamLogOptions()
         Additional upstream access log options.
         
        .envoy.extensions.filters.http.router.v3.Router.UpstreamAccessLogOptions upstream_log_options = 9;
        Returns:
        The upstreamLogOptions.
      • getUpstreamLogOptionsOrBuilder

        Router.UpstreamAccessLogOptionsOrBuilder getUpstreamLogOptionsOrBuilder()
         Additional upstream access log options.
         
        .envoy.extensions.filters.http.router.v3.Router.UpstreamAccessLogOptions upstream_log_options = 9;
      • getSuppressEnvoyHeaders

        boolean getSuppressEnvoyHeaders()
         Do not add any additional ``x-envoy-`` headers to requests or responses. This
         only affects the :ref:`router filter generated x-envoy- headers
         <config_http_filters_router_headers_set>`, other Envoy filters and the HTTP
         connection manager may continue to set ``x-envoy-`` headers.
         
        bool suppress_envoy_headers = 4;
        Returns:
        The suppressEnvoyHeaders.
      • getStrictCheckHeadersList

        java.util.List<java.lang.String> getStrictCheckHeadersList()
         Specifies a list of HTTP headers to strictly validate. Envoy will reject a
         request and respond with HTTP status 400 if the request contains an invalid
         value for any of the headers listed in this field. Strict header checking
         is only supported for the following headers:
        
         Value must be a ','-delimited list (i.e. no spaces) of supported retry
         policy values:
        
         * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
         * :ref:`config_http_filters_router_x-envoy-retry-on`
        
         Value must be an integer:
        
         * :ref:`config_http_filters_router_x-envoy-max-retries`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
         
        repeated string strict_check_headers = 5 [(.validate.rules) = { ... }
        Returns:
        A list containing the strictCheckHeaders.
      • getStrictCheckHeadersCount

        int getStrictCheckHeadersCount()
         Specifies a list of HTTP headers to strictly validate. Envoy will reject a
         request and respond with HTTP status 400 if the request contains an invalid
         value for any of the headers listed in this field. Strict header checking
         is only supported for the following headers:
        
         Value must be a ','-delimited list (i.e. no spaces) of supported retry
         policy values:
        
         * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
         * :ref:`config_http_filters_router_x-envoy-retry-on`
        
         Value must be an integer:
        
         * :ref:`config_http_filters_router_x-envoy-max-retries`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
         
        repeated string strict_check_headers = 5 [(.validate.rules) = { ... }
        Returns:
        The count of strictCheckHeaders.
      • getStrictCheckHeaders

        java.lang.String getStrictCheckHeaders​(int index)
         Specifies a list of HTTP headers to strictly validate. Envoy will reject a
         request and respond with HTTP status 400 if the request contains an invalid
         value for any of the headers listed in this field. Strict header checking
         is only supported for the following headers:
        
         Value must be a ','-delimited list (i.e. no spaces) of supported retry
         policy values:
        
         * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
         * :ref:`config_http_filters_router_x-envoy-retry-on`
        
         Value must be an integer:
        
         * :ref:`config_http_filters_router_x-envoy-max-retries`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
         
        repeated string strict_check_headers = 5 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The strictCheckHeaders at the given index.
      • getStrictCheckHeadersBytes

        com.google.protobuf.ByteString getStrictCheckHeadersBytes​(int index)
         Specifies a list of HTTP headers to strictly validate. Envoy will reject a
         request and respond with HTTP status 400 if the request contains an invalid
         value for any of the headers listed in this field. Strict header checking
         is only supported for the following headers:
        
         Value must be a ','-delimited list (i.e. no spaces) of supported retry
         policy values:
        
         * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
         * :ref:`config_http_filters_router_x-envoy-retry-on`
        
         Value must be an integer:
        
         * :ref:`config_http_filters_router_x-envoy-max-retries`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
         * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
         
        repeated string strict_check_headers = 5 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the strictCheckHeaders at the given index.
      • getRespectExpectedRqTimeout

        boolean getRespectExpectedRqTimeout()
         If not set, ingress Envoy will ignore
         :ref:`config_http_filters_router_x-envoy-expected-rq-timeout-ms` header, populated by egress
         Envoy, when deriving timeout for upstream cluster.
         
        bool respect_expected_rq_timeout = 6;
        Returns:
        The respectExpectedRqTimeout.
      • getSuppressGrpcRequestFailureCodeStats

        boolean getSuppressGrpcRequestFailureCodeStats()
         If set, Envoy will avoid incrementing HTTP failure code stats
         on gRPC requests. This includes the individual status code value
         (e.g. upstream_rq_504) and group stats (e.g. upstream_rq_5xx).
         This field is useful if interested in relying only on the gRPC
         stats filter to define success and failure metrics for gRPC requests
         as not all failed gRPC requests charge HTTP status code metrics. See
         :ref:`gRPC stats filter<config_http_filters_grpc_stats>` documentation
         for more details.
         
        bool suppress_grpc_request_failure_code_stats = 7;
        Returns:
        The suppressGrpcRequestFailureCodeStats.
      • getUpstreamHttpFiltersList

        java.util.List<HttpFilter> getUpstreamHttpFiltersList()
         .. note::
         Upstream HTTP filters are currently in alpha.
        
         Optional HTTP filters for the upstream HTTP filter chain.
        
         These filters will be applied for all requests that pass through the router.
         They will also be applied to shadowed requests.
         Upstream HTTP filters cannot change route or cluster.
         Upstream HTTP filters specified on the cluster will override these filters.
        
         If using upstream HTTP filters, please be aware that local errors sent by
         upstream HTTP filters will not trigger retries, and local errors sent by
         upstream HTTP filters will count as a final response if hedging is configured.
         [#extension-category: envoy.filters.http.upstream]
         
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;
      • getUpstreamHttpFilters

        HttpFilter getUpstreamHttpFilters​(int index)
         .. note::
         Upstream HTTP filters are currently in alpha.
        
         Optional HTTP filters for the upstream HTTP filter chain.
        
         These filters will be applied for all requests that pass through the router.
         They will also be applied to shadowed requests.
         Upstream HTTP filters cannot change route or cluster.
         Upstream HTTP filters specified on the cluster will override these filters.
        
         If using upstream HTTP filters, please be aware that local errors sent by
         upstream HTTP filters will not trigger retries, and local errors sent by
         upstream HTTP filters will count as a final response if hedging is configured.
         [#extension-category: envoy.filters.http.upstream]
         
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;
      • getUpstreamHttpFiltersCount

        int getUpstreamHttpFiltersCount()
         .. note::
         Upstream HTTP filters are currently in alpha.
        
         Optional HTTP filters for the upstream HTTP filter chain.
        
         These filters will be applied for all requests that pass through the router.
         They will also be applied to shadowed requests.
         Upstream HTTP filters cannot change route or cluster.
         Upstream HTTP filters specified on the cluster will override these filters.
        
         If using upstream HTTP filters, please be aware that local errors sent by
         upstream HTTP filters will not trigger retries, and local errors sent by
         upstream HTTP filters will count as a final response if hedging is configured.
         [#extension-category: envoy.filters.http.upstream]
         
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;
      • getUpstreamHttpFiltersOrBuilderList

        java.util.List<? extends HttpFilterOrBuilder> getUpstreamHttpFiltersOrBuilderList()
         .. note::
         Upstream HTTP filters are currently in alpha.
        
         Optional HTTP filters for the upstream HTTP filter chain.
        
         These filters will be applied for all requests that pass through the router.
         They will also be applied to shadowed requests.
         Upstream HTTP filters cannot change route or cluster.
         Upstream HTTP filters specified on the cluster will override these filters.
        
         If using upstream HTTP filters, please be aware that local errors sent by
         upstream HTTP filters will not trigger retries, and local errors sent by
         upstream HTTP filters will count as a final response if hedging is configured.
         [#extension-category: envoy.filters.http.upstream]
         
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;
      • getUpstreamHttpFiltersOrBuilder

        HttpFilterOrBuilder getUpstreamHttpFiltersOrBuilder​(int index)
         .. note::
         Upstream HTTP filters are currently in alpha.
        
         Optional HTTP filters for the upstream HTTP filter chain.
        
         These filters will be applied for all requests that pass through the router.
         They will also be applied to shadowed requests.
         Upstream HTTP filters cannot change route or cluster.
         Upstream HTTP filters specified on the cluster will override these filters.
        
         If using upstream HTTP filters, please be aware that local errors sent by
         upstream HTTP filters will not trigger retries, and local errors sent by
         upstream HTTP filters will count as a final response if hedging is configured.
         [#extension-category: envoy.filters.http.upstream]
         
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;