RouteOuterClass.RouteMatch (api 0.1.4 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - envoy.api.v2.route.RouteOuterClass.RouteMatch

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOuterClass.RouteMatchOrBuilder, Serializable

Enclosing class:

RouteOuterClass
```
public static final class RouteOuterClass.RouteMatch
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.RouteMatchOrBuilder
```
Protobuf type envoy.api.v2.route.RouteMatch

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RouteOuterClass.RouteMatch.Builder` Protobuf type `envoy.api.v2.route.RouteMatch`
`static class`	`RouteOuterClass.RouteMatch.PathSpecifierCase`

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CASE_SENSITIVE_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`PATH_FIELD_NUMBER`
`static int`	`PREFIX_FIELD_NUMBER`
`static int`	`QUERY_PARAMETERS_FIELD_NUMBER`
`static int`	`REGEX_FIELD_NUMBER`
`static int`	`RUNTIME_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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.
`static RouteOuterClass.RouteMatch`	`getDefaultInstance()`
`RouteOuterClass.RouteMatch`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<RouteOuterClass.RouteMatch>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasCaseSensitive()` Indicates that prefix/path matching should be case insensitive.
`int`	`hashCode()`
`boolean`	`hasRuntime()` Indicates that the route should additionally match on a runtime key.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static RouteOuterClass.RouteMatch.Builder`	`newBuilder()`
`static RouteOuterClass.RouteMatch.Builder`	`newBuilder(RouteOuterClass.RouteMatch prototype)`
`RouteOuterClass.RouteMatch.Builder`	`newBuilderForType()`
`protected RouteOuterClass.RouteMatch.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static RouteOuterClass.RouteMatch`	`parseDelimitedFrom(InputStream input)`
`static RouteOuterClass.RouteMatch`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteMatch`	`parseFrom(byte[] data)`
`static RouteOuterClass.RouteMatch`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteMatch`	`parseFrom(ByteBuffer data)`
`static RouteOuterClass.RouteMatch`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteMatch`	`parseFrom(com.google.protobuf.ByteString data)`
`static RouteOuterClass.RouteMatch`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteMatch`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RouteOuterClass.RouteMatch`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteMatch`	`parseFrom(InputStream input)`
`static RouteOuterClass.RouteMatch`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RouteOuterClass.RouteMatch>`	`parser()`
`RouteOuterClass.RouteMatch.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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
- PREFIX_FIELD_NUMBER
```
public static final int PREFIX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PATH_FIELD_NUMBER
```
public static final int PATH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REGEX_FIELD_NUMBER
```
public static final int REGEX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CASE_SENSITIVE_FIELD_NUMBER
```
public static final int CASE_SENSITIVE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RUNTIME_FIELD_NUMBER
```
public static final int RUNTIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_FIELD_NUMBER
```
public static final int QUERY_PARAMETERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

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

getPathSpecifierCase
```
public RouteOuterClass.RouteMatch.PathSpecifierCase getPathSpecifierCase()
```
Specified by:

getPathSpecifierCase in interface RouteOuterClass.RouteMatchOrBuilder

getPrefix

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;

Specified by:: getPrefix in interface RouteOuterClass.RouteMatchOrBuilder

getPrefixBytes

public 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;

Specified by:: getPrefixBytes in interface RouteOuterClass.RouteMatchOrBuilder

getPath

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;

Specified by:: getPath in interface RouteOuterClass.RouteMatchOrBuilder

getPathBytes

public 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;

Specified by:: getPathBytes in interface RouteOuterClass.RouteMatchOrBuilder

getRegex

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;

Specified by:: getRegex in interface RouteOuterClass.RouteMatchOrBuilder

getRegexBytes

public 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;

Specified by:: getRegexBytes in interface RouteOuterClass.RouteMatchOrBuilder

hasCaseSensitive
```
public boolean hasCaseSensitive()
```
```
 Indicates that prefix/path matching should be case insensitive. The default
 is true.
 
```
.google.protobuf.BoolValue case_sensitive = 4;
Specified by:

hasCaseSensitive in interface RouteOuterClass.RouteMatchOrBuilder

getCaseSensitive

public com.google.protobuf.BoolValue getCaseSensitive()

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

.google.protobuf.BoolValue case_sensitive = 4;

Specified by:: getCaseSensitive in interface RouteOuterClass.RouteMatchOrBuilder

getCaseSensitiveOrBuilder

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;

Specified by:: getCaseSensitiveOrBuilder in interface RouteOuterClass.RouteMatchOrBuilder

hasRuntime

public 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;

Specified by:: hasRuntime in interface RouteOuterClass.RouteMatchOrBuilder

getRuntime

public 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;

Specified by:: getRuntime in interface RouteOuterClass.RouteMatchOrBuilder

getRuntimeOrBuilder

public 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;

Specified by:: getRuntimeOrBuilder in interface RouteOuterClass.RouteMatchOrBuilder

getHeadersList

public 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;

Specified by:: getHeadersList in interface RouteOuterClass.RouteMatchOrBuilder

getHeadersOrBuilderList

public 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;

Specified by:: getHeadersOrBuilderList in interface RouteOuterClass.RouteMatchOrBuilder

getHeadersCount

public 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;

Specified by:: getHeadersCount in interface RouteOuterClass.RouteMatchOrBuilder

getHeaders

public 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;

Specified by:: getHeaders in interface RouteOuterClass.RouteMatchOrBuilder

getHeadersOrBuilder

public 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;

Specified by:: getHeadersOrBuilder in interface RouteOuterClass.RouteMatchOrBuilder