RouteOuterClass.RouteMatchOrBuilder (api 0.1.11 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RouteOuterClass.RouteMatch, RouteOuterClass.RouteMatch.Builder

Enclosing class:

RouteOuterClass
```
public static interface RouteOuterClass.RouteMatchOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.google.protobuf.BoolValue`	`getCaseSensitive()` Indicates that prefix/path matching should be case insensitive.
`com.google.protobuf.BoolValueOrBuilder`	`getCaseSensitiveOrBuilder()` Indicates that prefix/path matching should be case insensitive.
`RouteOuterClass.RouteMatch.GrpcRouteMatchOptions`	`getGrpc()` If specified, only gRPC requests will be matched.
`RouteOuterClass.RouteMatch.GrpcRouteMatchOptionsOrBuilder`	`getGrpcOrBuilder()` If specified, only gRPC requests will be matched.
`RouteOuterClass.HeaderMatcher`	`getHeaders(int index)` 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<RouteOuterClass.HeaderMatcher>`	`getHeadersList()` Specifies a set of headers that the route should match on.
`RouteOuterClass.HeaderMatcherOrBuilder`	`getHeadersOrBuilder(int index)` Specifies a set of headers that the route should match on.
`List<? extends RouteOuterClass.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.
`RouteOuterClass.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.
`RouteOuterClass.QueryParameterMatcher`	`getQueryParameters(int index)` 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<RouteOuterClass.QueryParameterMatcher>`	`getQueryParametersList()` Specifies a set of URL query parameters on which the route should match.
`RouteOuterClass.QueryParameterMatcherOrBuilder`	`getQueryParametersOrBuilder(int index)` Specifies a set of URL query parameters on which the route should match.
`List<? extends RouteOuterClass.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.
`Base.RuntimeUInt32`	`getRuntime()` Indicates that the route should additionally match on a runtime key.
`Base.RuntimeUInt32OrBuilder`	`getRuntimeOrBuilder()` 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`	`hasRuntime()` Indicates that the route should additionally match on a runtime key.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getPrefix

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;

getPrefixBytes

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;

getPath

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;

getPathBytes

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;

getRegex

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) = { ... }

getRegexBytes

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) = { ... }

hasCaseSensitive

boolean hasCaseSensitive()

 Indicates that prefix/path matching should be case insensitive. The default
 is true.

.google.protobuf.BoolValue case_sensitive = 4;

getCaseSensitive

com.google.protobuf.BoolValue getCaseSensitive()

 Indicates that prefix/path matching should be case insensitive. The default
 is true.

.google.protobuf.BoolValue case_sensitive = 4;

getCaseSensitiveOrBuilder

com.google.protobuf.BoolValueOrBuilder getCaseSensitiveOrBuilder()

 Indicates that prefix/path matching should be case insensitive. The default
 is true.

.google.protobuf.BoolValue case_sensitive = 4;

hasRuntime

boolean hasRuntime()

 Indicates that the route should additionally match on a runtime key. An
 integer between 0-100. Every time the route is considered for a match, a
 random number between 0-99 is selected. If the number is <= the value found
 in the key (checked first) or, if the key is not present, the default
 value, the route is a match (assuming everything also about the route
 matches). A runtime 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.

.envoy.api.v2.core.RuntimeUInt32 runtime = 5;

getRuntime

Base.RuntimeUInt32 getRuntime()

 Indicates that the route should additionally match on a runtime key. An
 integer between 0-100. Every time the route is considered for a match, a
 random number between 0-99 is selected. If the number is <= the value found
 in the key (checked first) or, if the key is not present, the default
 value, the route is a match (assuming everything also about the route
 matches). A runtime 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.

.envoy.api.v2.core.RuntimeUInt32 runtime = 5;

getRuntimeOrBuilder

Base.RuntimeUInt32OrBuilder getRuntimeOrBuilder()

 Indicates that the route should additionally match on a runtime key. An
 integer between 0-100. Every time the route is considered for a match, a
 random number between 0-99 is selected. If the number is <= the value found
 in the key (checked first) or, if the key is not present, the default
 value, the route is a match (assuming everything also about the route
 matches). A runtime 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.

.envoy.api.v2.core.RuntimeUInt32 runtime = 5;

getHeadersList

List<RouteOuterClass.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;

getHeaders

RouteOuterClass.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;

getHeadersCount

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;

getHeadersOrBuilderList

List<? extends RouteOuterClass.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;

getHeadersOrBuilder

RouteOuterClass.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;