io.envoyproxy.envoy.config.filter.http.router.v2

Class Router.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

io.envoyproxy.envoy.config.filter.http.router.v2.Router.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouterOrBuilder, Cloneable

Enclosing class:

Router

public static final class Router.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>
implements RouterOrBuilder

Protobuf type envoy.config.filter.http.router.v2.Router

Method Summary

Modifier and Type	Method and Description
Router.Builder	addAllUpstreamLog(Iterable<? extends AccessLog> values) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Router.Builder	addUpstreamLog(AccessLog.Builder builderForValue) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	addUpstreamLog(AccessLog value) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	addUpstreamLog(int index, AccessLog.Builder builderForValue) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	addUpstreamLog(int index, AccessLog value) Configuration for HTTP upstream logs emitted by the router.
AccessLog.Builder	addUpstreamLogBuilder() Configuration for HTTP upstream logs emitted by the router.
AccessLog.Builder	addUpstreamLogBuilder(int index) Configuration for HTTP upstream logs emitted by the router.
Router	build()
Router	buildPartial()
Router.Builder	clear()
Router.Builder	clearDynamicStats() Whether the router generates dynamic cluster statistics.
Router.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Router.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Router.Builder	clearStartChildSpan() Whether to start a child span for egress routed calls.
Router.Builder	clearSuppressEnvoyHeaders() Do not add any additional *x-envoy-* headers to requests or responses.
Router.Builder	clearUpstreamLog() Configuration for HTTP upstream logs emitted by the router.
Router.Builder	clone()
Router	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.BoolValue	getDynamicStats() Whether the router generates dynamic cluster statistics.
com.google.protobuf.BoolValue.Builder	getDynamicStatsBuilder() Whether the router generates dynamic cluster statistics.
com.google.protobuf.BoolValueOrBuilder	getDynamicStatsOrBuilder() Whether the router generates dynamic cluster statistics.
boolean	getStartChildSpan() Whether to start a child span for egress routed calls.
boolean	getSuppressEnvoyHeaders() Do not add any additional *x-envoy-* headers to requests or responses.
AccessLog	getUpstreamLog(int index) Configuration for HTTP upstream logs emitted by the router.
AccessLog.Builder	getUpstreamLogBuilder(int index) Configuration for HTTP upstream logs emitted by the router.
List<AccessLog.Builder>	getUpstreamLogBuilderList() 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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Router.Builder	mergeDynamicStats(com.google.protobuf.BoolValue value) Whether the router generates dynamic cluster statistics.
Router.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Router.Builder	mergeFrom(com.google.protobuf.Message other)
Router.Builder	mergeFrom(Router other)
Router.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Router.Builder	removeUpstreamLog(int index) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	setDynamicStats(com.google.protobuf.BoolValue.Builder builderForValue) Whether the router generates dynamic cluster statistics.
Router.Builder	setDynamicStats(com.google.protobuf.BoolValue value) Whether the router generates dynamic cluster statistics.
Router.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Router.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Router.Builder	setStartChildSpan(boolean value) Whether to start a child span for egress routed calls.
Router.Builder	setSuppressEnvoyHeaders(boolean value) Do not add any additional *x-envoy-* headers to requests or responses.
Router.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Router.Builder	setUpstreamLog(int index, AccessLog.Builder builderForValue) Configuration for HTTP upstream logs emitted by the router.
Router.Builder	setUpstreamLog(int index, AccessLog value) Configuration for HTTP upstream logs emitted by the router.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Router.Builder>

clear

public Router.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

getDefaultInstanceForType

public Router getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Router build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Router buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Router.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

setField

public Router.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

clearField

public Router.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

clearOneof

public Router.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

setRepeatedField

public Router.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

addRepeatedField

public Router.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

mergeFrom

public Router.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Router.Builder>

mergeFrom

public Router.Builder mergeFrom(Router other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

mergeFrom

public Router.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Router.Builder>

Throws:

IOException

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

setDynamicStats

public Router.Builder setDynamicStats(com.google.protobuf.BoolValue value)

 Whether the router generates dynamic cluster statistics. Defaults to
 true. Can be disabled in high performance scenarios.
 

.google.protobuf.BoolValue dynamic_stats = 1;

setDynamicStats

public Router.Builder setDynamicStats(com.google.protobuf.BoolValue.Builder builderForValue)

 Whether the router generates dynamic cluster statistics. Defaults to
 true. Can be disabled in high performance scenarios.
 

.google.protobuf.BoolValue dynamic_stats = 1;

mergeDynamicStats

public Router.Builder mergeDynamicStats(com.google.protobuf.BoolValue value)

 Whether the router generates dynamic cluster statistics. Defaults to
 true. Can be disabled in high performance scenarios.
 

.google.protobuf.BoolValue dynamic_stats = 1;

clearDynamicStats

public Router.Builder clearDynamicStats()

 Whether the router generates dynamic cluster statistics. Defaults to
 true. Can be disabled in high performance scenarios.
 

.google.protobuf.BoolValue dynamic_stats = 1;

getDynamicStatsBuilder

public com.google.protobuf.BoolValue.Builder getDynamicStatsBuilder()

 Whether the router generates dynamic cluster statistics. Defaults to
 true. Can be disabled in high performance scenarios.
 

.google.protobuf.BoolValue dynamic_stats = 1;

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

setStartChildSpan

public Router.Builder setStartChildSpan(boolean value)

 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;

clearStartChildSpan

public Router.Builder clearStartChildSpan()

 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;

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.filter.accesslog.v2.AccessLog upstream_log = 3;

Specified by:

getUpstreamLogList 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.filter.accesslog.v2.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.filter.accesslog.v2.AccessLog upstream_log = 3;

Specified by:

getUpstreamLog in interface RouterOrBuilder

setUpstreamLog

public Router.Builder setUpstreamLog(int index,
                                     AccessLog value)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

setUpstreamLog

public Router.Builder setUpstreamLog(int index,
                                     AccessLog.Builder builderForValue)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addUpstreamLog

public Router.Builder addUpstreamLog(AccessLog value)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addUpstreamLog

public Router.Builder addUpstreamLog(int index,
                                     AccessLog value)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addUpstreamLog

public Router.Builder addUpstreamLog(AccessLog.Builder builderForValue)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addUpstreamLog

public Router.Builder addUpstreamLog(int index,
                                     AccessLog.Builder builderForValue)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addAllUpstreamLog

public Router.Builder addAllUpstreamLog(Iterable<? extends AccessLog> values)

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

clearUpstreamLog

public Router.Builder clearUpstreamLog()

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

removeUpstreamLog

public Router.Builder removeUpstreamLog(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.filter.accesslog.v2.AccessLog upstream_log = 3;

getUpstreamLogBuilder

public AccessLog.Builder getUpstreamLogBuilder(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.filter.accesslog.v2.AccessLog upstream_log = 3;

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.filter.accesslog.v2.AccessLog upstream_log = 3;

Specified by:

getUpstreamLogOrBuilder 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.filter.accesslog.v2.AccessLog upstream_log = 3;

Specified by:

getUpstreamLogOrBuilderList in interface RouterOrBuilder

addUpstreamLogBuilder

public AccessLog.Builder addUpstreamLogBuilder()

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

addUpstreamLogBuilder

public AccessLog.Builder addUpstreamLogBuilder(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.filter.accesslog.v2.AccessLog upstream_log = 3;

getUpstreamLogBuilderList

public List<AccessLog.Builder> getUpstreamLogBuilderList()

 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.filter.accesslog.v2.AccessLog upstream_log = 3;

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

setSuppressEnvoyHeaders

public Router.Builder setSuppressEnvoyHeaders(boolean value)

 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;

clearSuppressEnvoyHeaders

public Router.Builder clearSuppressEnvoyHeaders()

 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;

setUnknownFields

public final Router.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

mergeUnknownFields

public final Router.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>