Package io.envoyproxy.envoy.extensions.filters.http.router.v3

Class Router

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouterOrBuilder, Serializable
    public final class Router
extends com.google.protobuf.GeneratedMessageV3
implements RouterOrBuilder
     [#next-free-field: 8]
    Protobuf type envoy.extensions.filters.http.router.v3.Router
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Router.Builder
      [#next-free-field: 8]

      • 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 Detail

      • DYNAMIC_STATS_FIELD_NUMBER

        public static final int DYNAMIC_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_CHILD_SPAN_FIELD_NUMBER

        public static final int START_CHILD_SPAN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPSTREAM_LOG_FIELD_NUMBER

        public static final int UPSTREAM_LOG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPRESS_ENVOY_HEADERS_FIELD_NUMBER

        public static final int SUPPRESS_ENVOY_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STRICT_CHECK_HEADERS_FIELD_NUMBER

        public static final int STRICT_CHECK_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPECT_EXPECTED_RQ_TIMEOUT_FIELD_NUMBER

        public static final int RESPECT_EXPECTED_RQ_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPRESS_GRPC_REQUEST_FAILURE_CODE_STATS_FIELD_NUMBER

        public static final int SUPPRESS_GRPC_REQUEST_FAILURE_CODE_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • hasDynamicStats

        public 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;
        Specified by:
        hasDynamicStats in interface RouterOrBuilder
        Returns:
        Whether the dynamicStats field is set.

      • getDynamicStats

        public 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;
        Specified by:
        getDynamicStats in interface RouterOrBuilder
        Returns:
        The dynamicStats.

      • getDynamicStatsOrBuilder

        public 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;
        Specified by:
        getDynamicStatsOrBuilder in interface RouterOrBuilder

      • getStartChildSpan

        public boolean getStartChildSpan()
         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.
        bool start_child_span = 2;
        Specified by:
        getStartChildSpan in interface RouterOrBuilder
        Returns:
        The startChildSpan.

      • getUpstreamLogList

        public 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;
        Specified by:
        getUpstreamLogList in interface RouterOrBuilder

      • getUpstreamLogOrBuilderList

        public 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;
        Specified by:
        getUpstreamLogOrBuilderList in interface RouterOrBuilder

      • getUpstreamLogCount

        public 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;
        Specified by:
        getUpstreamLogCount in interface RouterOrBuilder

      • getUpstreamLog

        public 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;
        Specified by:
        getUpstreamLog in interface RouterOrBuilder

      • getUpstreamLogOrBuilder

        public 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;
        Specified by:
        getUpstreamLogOrBuilder in interface RouterOrBuilder

      • getSuppressEnvoyHeaders

        public 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;
        Specified by:
        getSuppressEnvoyHeaders in interface RouterOrBuilder
        Returns:
        The suppressEnvoyHeaders.

      • getStrictCheckHeadersList

        public com.google.protobuf.ProtocolStringList 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) = { ... }
        Specified by:
        getStrictCheckHeadersList in interface RouterOrBuilder
        Returns:
        A list containing the strictCheckHeaders.

      • getStrictCheckHeadersCount

        public 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) = { ... }
        Specified by:
        getStrictCheckHeadersCount in interface RouterOrBuilder
        Returns:
        The count of strictCheckHeaders.

      • getStrictCheckHeaders

        public 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) = { ... }
        Specified by:
        getStrictCheckHeaders in interface RouterOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The strictCheckHeaders at the given index.

      • getStrictCheckHeadersBytes

        public 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) = { ... }
        Specified by:
        getStrictCheckHeadersBytes in interface RouterOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the strictCheckHeaders at the given index.

      • getRespectExpectedRqTimeout

        public 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;
        Specified by:
        getRespectExpectedRqTimeout in interface RouterOrBuilder
        Returns:
        The respectExpectedRqTimeout.

      • getSuppressGrpcRequestFailureCodeStats

        public 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;
        Specified by:
        getSuppressGrpcRequestFailureCodeStats in interface RouterOrBuilder
        Returns:
        The suppressGrpcRequestFailureCodeStats.

      • 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 Router parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Router getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Router> parser()

      • getParserForType

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