io.envoyproxy.envoy.extensions.filters.http.router.v4alpha

Class Router

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.router.v4alpha.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: 7]
 

Protobuf type envoy.extensions.filters.http.router.v4alpha.Router

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Router.Builder [#next-free-field: 7] Protobuf type envoy.extensions.filters.http.router.v4alpha.Router

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DYNAMIC_STATS_FIELD_NUMBER
static int	RESPECT_EXPECTED_RQ_TIMEOUT_FIELD_NUMBER
static int	START_CHILD_SPAN_FIELD_NUMBER
static int	STRICT_CHECK_HEADERS_FIELD_NUMBER
static int	SUPPRESS_ENVOY_HEADERS_FIELD_NUMBER
static int	UPSTREAM_LOG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Router	getDefaultInstance()
Router	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.BoolValue	getDynamicStats() Whether the router generates dynamic cluster statistics.
com.google.protobuf.BoolValueOrBuilder	getDynamicStatsOrBuilder() Whether the router generates dynamic cluster statistics.
com.google.protobuf.Parser<Router>	getParserForType()
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.
int	getSerializedSize()
boolean	getStartChildSpan() Whether to start a child span for egress routed calls.
String	getStrictCheckHeaders(int index) Specifies a list of HTTP headers to strictly validate.
com.google.protobuf.ByteString	getStrictCheckHeadersBytes(int index) Specifies a list of HTTP headers to strictly validate.
int	getStrictCheckHeadersCount() Specifies a list of HTTP headers to strictly validate.
com.google.protobuf.ProtocolStringList	getStrictCheckHeadersList() Specifies a list of HTTP headers to strictly validate.
boolean	getSuppressEnvoyHeaders() Do not add any additional *x-envoy-* headers to requests or responses.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
AccessLog	getUpstreamLog(int index) Configuration for HTTP upstream logs emitted by the router.
int	getUpstreamLogCount() Configuration for HTTP upstream logs emitted by the router.
List<AccessLog>	getUpstreamLogList() Configuration for HTTP upstream logs emitted by the router.
AccessLogOrBuilder	getUpstreamLogOrBuilder(int index) Configuration for HTTP upstream logs emitted by the router.
List<? extends AccessLogOrBuilder>	getUpstreamLogOrBuilderList() Configuration for HTTP upstream logs emitted by the router.
boolean	hasDynamicStats() Whether the router generates dynamic cluster statistics.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Router.Builder	newBuilder()
static Router.Builder	newBuilder(Router prototype)
Router.Builder	newBuilderForType()
protected Router.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Router	parseDelimitedFrom(InputStream input)
static Router	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Router	parseFrom(byte[] data)
static Router	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Router	parseFrom(ByteBuffer data)
static Router	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Router	parseFrom(com.google.protobuf.ByteString data)
static Router	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Router	parseFrom(com.google.protobuf.CodedInputStream input)
static Router	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Router	parseFrom(InputStream input)
static Router	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Router>	parser()
Router.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

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

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

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.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.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.v4alpha.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

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

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

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

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

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

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(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Router parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Router parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Router parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Router parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

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

newBuilder

public static Router.Builder newBuilder()

newBuilder

public static Router.Builder newBuilder(Router prototype)

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