public static final class RouteMatch.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder> implements RouteMatchOrBuilder
envoy.api.v2.route.RouteMatch| Modifier and Type | Method and Description |
|---|---|
RouteMatch.Builder |
addAllHeaders(Iterable<? extends HeaderMatcher> values)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
addAllQueryParameters(Iterable<? extends QueryParameterMatcher> values)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
addHeaders(HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
addHeaders(HeaderMatcher value)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
addHeaders(int index,
HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
addHeaders(int index,
HeaderMatcher value)
Specifies a set of headers that the route should match on.
|
HeaderMatcher.Builder |
addHeadersBuilder()
Specifies a set of headers that the route should match on.
|
HeaderMatcher.Builder |
addHeadersBuilder(int index)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
addQueryParameters(int index,
QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
addQueryParameters(int index,
QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
addQueryParameters(QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
addQueryParameters(QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should
match.
|
QueryParameterMatcher.Builder |
addQueryParametersBuilder()
Specifies a set of URL query parameters on which the route should
match.
|
QueryParameterMatcher.Builder |
addQueryParametersBuilder(int index)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RouteMatch |
build() |
RouteMatch |
buildPartial() |
RouteMatch.Builder |
clear() |
RouteMatch.Builder |
clearCaseSensitive()
Indicates that prefix/path matching should be case insensitive.
|
RouteMatch.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RouteMatch.Builder |
clearGrpc()
If specified, only gRPC requests will be matched.
|
RouteMatch.Builder |
clearHeaders()
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RouteMatch.Builder |
clearPath()
If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
clearPathSpecifier() |
RouteMatch.Builder |
clearPrefix()
If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
|
RouteMatch.Builder |
clearQueryParameters()
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
clearRegex()
If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
clearRuntimeFraction()
Indicates that the route should additionally match on a runtime key.
|
RouteMatch.Builder |
clone() |
com.google.protobuf.BoolValue |
getCaseSensitive()
Indicates that prefix/path matching should be case insensitive.
|
com.google.protobuf.BoolValue.Builder |
getCaseSensitiveBuilder()
Indicates that prefix/path matching should be case insensitive.
|
com.google.protobuf.BoolValueOrBuilder |
getCaseSensitiveOrBuilder()
Indicates that prefix/path matching should be case insensitive.
|
RouteMatch |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
RouteMatch.GrpcRouteMatchOptions |
getGrpc()
If specified, only gRPC requests will be matched.
|
RouteMatch.GrpcRouteMatchOptions.Builder |
getGrpcBuilder()
If specified, only gRPC requests will be matched.
|
RouteMatch.GrpcRouteMatchOptionsOrBuilder |
getGrpcOrBuilder()
If specified, only gRPC requests will be matched.
|
HeaderMatcher |
getHeaders(int index)
Specifies a set of headers that the route should match on.
|
HeaderMatcher.Builder |
getHeadersBuilder(int index)
Specifies a set of headers that the route should match on.
|
List<HeaderMatcher.Builder> |
getHeadersBuilderList()
Specifies a set of headers that the route should match on.
|
int |
getHeadersCount()
Specifies a set of headers that the route should match on.
|
List<HeaderMatcher> |
getHeadersList()
Specifies a set of headers that the route should match on.
|
HeaderMatcherOrBuilder |
getHeadersOrBuilder(int index)
Specifies a set of headers that the route should match on.
|
List<? extends HeaderMatcherOrBuilder> |
getHeadersOrBuilderList()
Specifies a set of headers that the route should match on.
|
String |
getPath()
If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
|
com.google.protobuf.ByteString |
getPathBytes()
If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
|
RouteMatch.PathSpecifierCase |
getPathSpecifierCase() |
String |
getPrefix()
If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
|
com.google.protobuf.ByteString |
getPrefixBytes()
If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
|
QueryParameterMatcher |
getQueryParameters(int index)
Specifies a set of URL query parameters on which the route should
match.
|
QueryParameterMatcher.Builder |
getQueryParametersBuilder(int index)
Specifies a set of URL query parameters on which the route should
match.
|
List<QueryParameterMatcher.Builder> |
getQueryParametersBuilderList()
Specifies a set of URL query parameters on which the route should
match.
|
int |
getQueryParametersCount()
Specifies a set of URL query parameters on which the route should
match.
|
List<QueryParameterMatcher> |
getQueryParametersList()
Specifies a set of URL query parameters on which the route should
match.
|
QueryParameterMatcherOrBuilder |
getQueryParametersOrBuilder(int index)
Specifies a set of URL query parameters on which the route should
match.
|
List<? extends QueryParameterMatcherOrBuilder> |
getQueryParametersOrBuilderList()
Specifies a set of URL query parameters on which the route should
match.
|
String |
getRegex()
If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed.
|
com.google.protobuf.ByteString |
getRegexBytes()
If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed.
|
RuntimeFractionalPercent |
getRuntimeFraction()
Indicates that the route should additionally match on a runtime key.
|
RuntimeFractionalPercent.Builder |
getRuntimeFractionBuilder()
Indicates that the route should additionally match on a runtime key.
|
RuntimeFractionalPercentOrBuilder |
getRuntimeFractionOrBuilder()
Indicates that the route should additionally match on a runtime key.
|
boolean |
hasCaseSensitive()
Indicates that prefix/path matching should be case insensitive.
|
boolean |
hasGrpc()
If specified, only gRPC requests will be matched.
|
boolean |
hasRuntimeFraction()
Indicates that the route should additionally match on a runtime key.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RouteMatch.Builder |
mergeCaseSensitive(com.google.protobuf.BoolValue value)
Indicates that prefix/path matching should be case insensitive.
|
RouteMatch.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RouteMatch.Builder |
mergeFrom(com.google.protobuf.Message other) |
RouteMatch.Builder |
mergeFrom(RouteMatch other) |
RouteMatch.Builder |
mergeGrpc(RouteMatch.GrpcRouteMatchOptions value)
If specified, only gRPC requests will be matched.
|
RouteMatch.Builder |
mergeRuntimeFraction(RuntimeFractionalPercent value)
Indicates that the route should additionally match on a runtime key.
|
RouteMatch.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RouteMatch.Builder |
removeHeaders(int index)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
removeQueryParameters(int index)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
setCaseSensitive(com.google.protobuf.BoolValue.Builder builderForValue)
Indicates that prefix/path matching should be case insensitive.
|
RouteMatch.Builder |
setCaseSensitive(com.google.protobuf.BoolValue value)
Indicates that prefix/path matching should be case insensitive.
|
RouteMatch.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RouteMatch.Builder |
setGrpc(RouteMatch.GrpcRouteMatchOptions.Builder builderForValue)
If specified, only gRPC requests will be matched.
|
RouteMatch.Builder |
setGrpc(RouteMatch.GrpcRouteMatchOptions value)
If specified, only gRPC requests will be matched.
|
RouteMatch.Builder |
setHeaders(int index,
HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
setHeaders(int index,
HeaderMatcher value)
Specifies a set of headers that the route should match on.
|
RouteMatch.Builder |
setPath(String value)
If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
setPathBytes(com.google.protobuf.ByteString value)
If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
setPrefix(String value)
If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
|
RouteMatch.Builder |
setPrefixBytes(com.google.protobuf.ByteString value)
If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
|
RouteMatch.Builder |
setQueryParameters(int index,
QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
setQueryParameters(int index,
QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should
match.
|
RouteMatch.Builder |
setRegex(String value)
If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
setRegexBytes(com.google.protobuf.ByteString value)
If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed.
|
RouteMatch.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RouteMatch.Builder |
setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue)
Indicates that the route should additionally match on a runtime key.
|
RouteMatch.Builder |
setRuntimeFraction(RuntimeFractionalPercent value)
Indicates that the route should additionally match on a runtime key.
|
RouteMatch.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RouteMatch build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RouteMatch buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RouteMatch.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RouteMatch.Builder>public RouteMatch.Builder mergeFrom(RouteMatch other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public RouteMatch.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RouteMatch.Builder>IOExceptionpublic RouteMatch.PathSpecifierCase getPathSpecifierCase()
getPathSpecifierCase in interface RouteMatchOrBuilderpublic RouteMatch.Builder clearPathSpecifier()
public String getPrefix()
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string prefix = 1;getPrefix in interface RouteMatchOrBuilderpublic com.google.protobuf.ByteString getPrefixBytes()
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string prefix = 1;getPrefixBytes in interface RouteMatchOrBuilderpublic RouteMatch.Builder setPrefix(String value)
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string prefix = 1;public RouteMatch.Builder clearPrefix()
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string prefix = 1;public RouteMatch.Builder setPrefixBytes(com.google.protobuf.ByteString value)
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string prefix = 1;public String getPath()
If specified, the route is an exact path rule meaning that the path must exactly match the *:path* header once the query string is removed.
string path = 2;getPath in interface RouteMatchOrBuilderpublic com.google.protobuf.ByteString getPathBytes()
If specified, the route is an exact path rule meaning that the path must exactly match the *:path* header once the query string is removed.
string path = 2;getPathBytes in interface RouteMatchOrBuilderpublic RouteMatch.Builder setPath(String value)
If specified, the route is an exact path rule meaning that the path must exactly match the *:path* header once the query string is removed.
string path = 2;public RouteMatch.Builder clearPath()
If specified, the route is an exact path rule meaning that the path must exactly match the *:path* header once the query string is removed.
string path = 2;public RouteMatch.Builder setPathBytes(com.google.protobuf.ByteString value)
If specified, the route is an exact path rule meaning that the path must exactly match the *:path* header once the query string is removed.
string path = 2;public String getRegex()
If specified, the route is a regular expression rule meaning that the regex must match the *:path* header once the query string is removed. The entire path (without the query string) must match the regex. The rule will not match if only a subsequence of the *:path* header matches the regex. The regex grammar is defined `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex */b[io]t* matches the path */bit* * The regex */b[io]t* matches the path */bot* * The regex */b[io]t* does not match the path */bite* * The regex */b[io]t* does not match the path */bit/bot*
string regex = 3 [(.validate.rules) = { ... }getRegex in interface RouteMatchOrBuilderpublic com.google.protobuf.ByteString getRegexBytes()
If specified, the route is a regular expression rule meaning that the regex must match the *:path* header once the query string is removed. The entire path (without the query string) must match the regex. The rule will not match if only a subsequence of the *:path* header matches the regex. The regex grammar is defined `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex */b[io]t* matches the path */bit* * The regex */b[io]t* matches the path */bot* * The regex */b[io]t* does not match the path */bite* * The regex */b[io]t* does not match the path */bit/bot*
string regex = 3 [(.validate.rules) = { ... }getRegexBytes in interface RouteMatchOrBuilderpublic RouteMatch.Builder setRegex(String value)
If specified, the route is a regular expression rule meaning that the regex must match the *:path* header once the query string is removed. The entire path (without the query string) must match the regex. The rule will not match if only a subsequence of the *:path* header matches the regex. The regex grammar is defined `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex */b[io]t* matches the path */bit* * The regex */b[io]t* matches the path */bot* * The regex */b[io]t* does not match the path */bite* * The regex */b[io]t* does not match the path */bit/bot*
string regex = 3 [(.validate.rules) = { ... }public RouteMatch.Builder clearRegex()
If specified, the route is a regular expression rule meaning that the regex must match the *:path* header once the query string is removed. The entire path (without the query string) must match the regex. The rule will not match if only a subsequence of the *:path* header matches the regex. The regex grammar is defined `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex */b[io]t* matches the path */bit* * The regex */b[io]t* matches the path */bot* * The regex */b[io]t* does not match the path */bite* * The regex */b[io]t* does not match the path */bit/bot*
string regex = 3 [(.validate.rules) = { ... }public RouteMatch.Builder setRegexBytes(com.google.protobuf.ByteString value)
If specified, the route is a regular expression rule meaning that the regex must match the *:path* header once the query string is removed. The entire path (without the query string) must match the regex. The rule will not match if only a subsequence of the *:path* header matches the regex. The regex grammar is defined `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex */b[io]t* matches the path */bit* * The regex */b[io]t* matches the path */bot* * The regex */b[io]t* does not match the path */bite* * The regex */b[io]t* does not match the path */bit/bot*
string regex = 3 [(.validate.rules) = { ... }public boolean hasCaseSensitive()
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;hasCaseSensitive in interface RouteMatchOrBuilderpublic com.google.protobuf.BoolValue getCaseSensitive()
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;getCaseSensitive in interface RouteMatchOrBuilderpublic RouteMatch.Builder setCaseSensitive(com.google.protobuf.BoolValue value)
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;public RouteMatch.Builder setCaseSensitive(com.google.protobuf.BoolValue.Builder builderForValue)
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;public RouteMatch.Builder mergeCaseSensitive(com.google.protobuf.BoolValue value)
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;public RouteMatch.Builder clearCaseSensitive()
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;public com.google.protobuf.BoolValue.Builder getCaseSensitiveBuilder()
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;public com.google.protobuf.BoolValueOrBuilder getCaseSensitiveOrBuilder()
Indicates that prefix/path matching should be case insensitive. The default is true.
.google.protobuf.BoolValue case_sensitive = 4;getCaseSensitiveOrBuilder in interface RouteMatchOrBuilderpublic boolean hasRuntimeFraction()
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;hasRuntimeFraction in interface RouteMatchOrBuilderpublic RuntimeFractionalPercent getRuntimeFraction()
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;getRuntimeFraction in interface RouteMatchOrBuilderpublic RouteMatch.Builder setRuntimeFraction(RuntimeFractionalPercent value)
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;public RouteMatch.Builder setRuntimeFraction(RuntimeFractionalPercent.Builder builderForValue)
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;public RouteMatch.Builder mergeRuntimeFraction(RuntimeFractionalPercent value)
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;public RouteMatch.Builder clearRuntimeFraction()
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;public RuntimeFractionalPercent.Builder getRuntimeFractionBuilder()
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;public RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()
Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.envoy.api.v2.core.RuntimeFractionalPercent runtime_fraction = 9;getRuntimeFractionOrBuilder in interface RouteMatchOrBuilderpublic List<HeaderMatcher> getHeadersList()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;getHeadersList in interface RouteMatchOrBuilderpublic int getHeadersCount()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;getHeadersCount in interface RouteMatchOrBuilderpublic HeaderMatcher getHeaders(int index)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;getHeaders in interface RouteMatchOrBuilderpublic RouteMatch.Builder setHeaders(int index, HeaderMatcher value)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder setHeaders(int index, HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder addHeaders(HeaderMatcher value)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder addHeaders(int index, HeaderMatcher value)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder addHeaders(HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder addHeaders(int index, HeaderMatcher.Builder builderForValue)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder addAllHeaders(Iterable<? extends HeaderMatcher> values)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder clearHeaders()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public RouteMatch.Builder removeHeaders(int index)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public HeaderMatcher.Builder getHeadersBuilder(int index)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public HeaderMatcherOrBuilder getHeadersOrBuilder(int index)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;getHeadersOrBuilder in interface RouteMatchOrBuilderpublic List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;getHeadersOrBuilderList in interface RouteMatchOrBuilderpublic HeaderMatcher.Builder addHeadersBuilder()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public HeaderMatcher.Builder addHeadersBuilder(int index)
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public List<HeaderMatcher.Builder> getHeadersBuilderList()
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config).
repeated .envoy.api.v2.route.HeaderMatcher headers = 6;public List<QueryParameterMatcher> getQueryParametersList()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;getQueryParametersList in interface RouteMatchOrBuilderpublic int getQueryParametersCount()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;getQueryParametersCount in interface RouteMatchOrBuilderpublic QueryParameterMatcher getQueryParameters(int index)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;getQueryParameters in interface RouteMatchOrBuilderpublic RouteMatch.Builder setQueryParameters(int index, QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder setQueryParameters(int index, QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder addQueryParameters(QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder addQueryParameters(int index, QueryParameterMatcher value)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder addQueryParameters(QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder addQueryParameters(int index, QueryParameterMatcher.Builder builderForValue)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder addAllQueryParameters(Iterable<? extends QueryParameterMatcher> values)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder clearQueryParameters()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public RouteMatch.Builder removeQueryParameters(int index)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public QueryParameterMatcher.Builder getQueryParametersBuilder(int index)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public QueryParameterMatcherOrBuilder getQueryParametersOrBuilder(int index)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;getQueryParametersOrBuilder in interface RouteMatchOrBuilderpublic List<? extends QueryParameterMatcherOrBuilder> getQueryParametersOrBuilderList()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;getQueryParametersOrBuilderList in interface RouteMatchOrBuilderpublic QueryParameterMatcher.Builder addQueryParametersBuilder()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public QueryParameterMatcher.Builder addQueryParametersBuilder(int index)
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public List<QueryParameterMatcher.Builder> getQueryParametersBuilderList()
Specifies a set of URL query parameters on which the route should match. The router will check the query string from the *path* header against all the specified query parameters. If the number of specified query parameters is nonzero, they all must match the *path* header's query string for a match to occur.
repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters = 7;public boolean hasGrpc()
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;hasGrpc in interface RouteMatchOrBuilderpublic RouteMatch.GrpcRouteMatchOptions getGrpc()
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;getGrpc in interface RouteMatchOrBuilderpublic RouteMatch.Builder setGrpc(RouteMatch.GrpcRouteMatchOptions value)
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;public RouteMatch.Builder setGrpc(RouteMatch.GrpcRouteMatchOptions.Builder builderForValue)
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;public RouteMatch.Builder mergeGrpc(RouteMatch.GrpcRouteMatchOptions value)
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;public RouteMatch.Builder clearGrpc()
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;public RouteMatch.GrpcRouteMatchOptions.Builder getGrpcBuilder()
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;public RouteMatch.GrpcRouteMatchOptionsOrBuilder getGrpcOrBuilder()
If specified, only gRPC requests will be matched. The router will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
.envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions grpc = 8;getGrpcOrBuilder in interface RouteMatchOrBuilderpublic final RouteMatch.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>public final RouteMatch.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RouteMatch.Builder>Copyright © 2018–2019 The Envoy Project. All rights reserved.