RouteOuterClass.Route (api 0.1.3 API)

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

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOuterClass.RouteOrBuilder, Serializable

Enclosing class:: RouteOuterClass

public static final class RouteOuterClass.Route
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.RouteOrBuilder

 A route is both a specification of how to match a request as well as an indication of what to do
 next (e.g., redirect, forward, rewrite, etc.).
 .. attention::
   Envoy supports routing on HTTP method via :ref:`header matching
   <envoy_api_msg_route.HeaderMatcher>`.

Protobuf type envoy.api.v2.route.Route

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RouteOuterClass.Route.ActionCase`
`static class`	`RouteOuterClass.Route.Builder` A route is both a specification of how to match a request as well as an indication of what to do next (e.g., redirect, forward, rewrite, etc.). .. attention:: Envoy supports routing on HTTP method via :ref:`header matching <envoy_api_msg_route.HeaderMatcher>`.

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`	`AUTH_FIELD_NUMBER`
`static int`	`DECORATOR_FIELD_NUMBER`
`static int`	`DIRECT_RESPONSE_FIELD_NUMBER`
`static int`	`MATCH_FIELD_NUMBER`
`static int`	`METADATA_FIELD_NUMBER`
`static int`	`PER_FILTER_CONFIG_FIELD_NUMBER`
`static int`	`REDIRECT_FIELD_NUMBER`
`static int`	`ROUTE_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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsPerFilterConfig(String key)` The per_filter_config field can be used to provide route-specific configurations for filters.
`boolean`	`equals(Object obj)`
`RouteOuterClass.Route.ActionCase`	`getActionCase()`
`Auth.AuthAction`	`getAuth()` [#not-implemented-hide:] Return a 401/403 when auth checks fail.
`Auth.AuthActionOrBuilder`	`getAuthOrBuilder()` [#not-implemented-hide:] Return a 401/403 when auth checks fail.
`RouteOuterClass.Decorator`	`getDecorator()` Decorator for the matched route.
`RouteOuterClass.DecoratorOrBuilder`	`getDecoratorOrBuilder()` Decorator for the matched route.
`static RouteOuterClass.Route`	`getDefaultInstance()`
`RouteOuterClass.Route`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`RouteOuterClass.DirectResponseAction`	`getDirectResponse()` Return an arbitrary HTTP response directly, without proxying.
`RouteOuterClass.DirectResponseActionOrBuilder`	`getDirectResponseOrBuilder()` Return an arbitrary HTTP response directly, without proxying.
`RouteOuterClass.RouteMatch`	`getMatch()` Route matching parameters.
`RouteOuterClass.RouteMatchOrBuilder`	`getMatchOrBuilder()` Route matching parameters.
`Base.Metadata`	`getMetadata()` The Metadata field can be used to provide additional information about the route.
`Base.MetadataOrBuilder`	`getMetadataOrBuilder()` The Metadata field can be used to provide additional information about the route.
`com.google.protobuf.Parser<RouteOuterClass.Route>`	`getParserForType()`
`Map<String,com.google.protobuf.Struct>`	`getPerFilterConfig()` Deprecated.
`int`	`getPerFilterConfigCount()` The per_filter_config field can be used to provide route-specific configurations for filters.
`Map<String,com.google.protobuf.Struct>`	`getPerFilterConfigMap()` The per_filter_config field can be used to provide route-specific configurations for filters.
`com.google.protobuf.Struct`	`getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)` The per_filter_config field can be used to provide route-specific configurations for filters.
`com.google.protobuf.Struct`	`getPerFilterConfigOrThrow(String key)` The per_filter_config field can be used to provide route-specific configurations for filters.
`RouteOuterClass.RedirectAction`	`getRedirect()` Return a redirect.
`RouteOuterClass.RedirectActionOrBuilder`	`getRedirectOrBuilder()` Return a redirect.
`RouteOuterClass.RouteAction`	`getRoute()` Route request to some upstream cluster.
`RouteOuterClass.RouteActionOrBuilder`	`getRouteOrBuilder()` Route request to some upstream cluster.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasAuth()` [#not-implemented-hide:] Return a 401/403 when auth checks fail.
`boolean`	`hasDecorator()` Decorator for the matched route.
`boolean`	`hasDirectResponse()` Return an arbitrary HTTP response directly, without proxying.
`int`	`hashCode()`
`boolean`	`hasMatch()` Route matching parameters.
`boolean`	`hasMetadata()` The Metadata field can be used to provide additional information about the route.
`boolean`	`hasRedirect()` Return a redirect.
`boolean`	`hasRoute()` Route request to some upstream cluster.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static RouteOuterClass.Route.Builder`	`newBuilder()`
`static RouteOuterClass.Route.Builder`	`newBuilder(RouteOuterClass.Route prototype)`
`RouteOuterClass.Route.Builder`	`newBuilderForType()`
`protected RouteOuterClass.Route.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static RouteOuterClass.Route`	`parseDelimitedFrom(InputStream input)`
`static RouteOuterClass.Route`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.Route`	`parseFrom(byte[] data)`
`static RouteOuterClass.Route`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.Route`	`parseFrom(ByteBuffer data)`
`static RouteOuterClass.Route`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.Route`	`parseFrom(com.google.protobuf.ByteString data)`
`static RouteOuterClass.Route`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.Route`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RouteOuterClass.Route`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.Route`	`parseFrom(InputStream input)`
`static RouteOuterClass.Route`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RouteOuterClass.Route>`	`parser()`
`RouteOuterClass.Route.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, 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
- MATCH_FIELD_NUMBER
```
public static final int MATCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROUTE_FIELD_NUMBER
```
public static final int ROUTE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REDIRECT_FIELD_NUMBER
```
public static final int REDIRECT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIRECT_RESPONSE_FIELD_NUMBER
```
public static final int DIRECT_RESPONSE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DECORATOR_FIELD_NUMBER
```
public static final int DECORATOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUTH_FIELD_NUMBER
```
public static final int AUTH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PER_FILTER_CONFIG_FIELD_NUMBER
```
public static final int PER_FILTER_CONFIG_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()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getActionCase
```
public RouteOuterClass.Route.ActionCase getActionCase()
```
Specified by:

getActionCase in interface RouteOuterClass.RouteOrBuilder

hasMatch
```
public boolean hasMatch()
```
```
 Route matching parameters.
 
```
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }
Specified by:

hasMatch in interface RouteOuterClass.RouteOrBuilder

getMatch
```
public RouteOuterClass.RouteMatch getMatch()
```
```
 Route matching parameters.
 
```
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }
Specified by:

getMatch in interface RouteOuterClass.RouteOrBuilder

getMatchOrBuilder
```
public RouteOuterClass.RouteMatchOrBuilder getMatchOrBuilder()
```
```
 Route matching parameters.
 
```
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }
Specified by:

getMatchOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasRoute
```
public boolean hasRoute()
```
```
 Route request to some upstream cluster.
 
```
.envoy.api.v2.route.RouteAction route = 2;
Specified by:

hasRoute in interface RouteOuterClass.RouteOrBuilder

getRoute
```
public RouteOuterClass.RouteAction getRoute()
```
```
 Route request to some upstream cluster.
 
```
.envoy.api.v2.route.RouteAction route = 2;
Specified by:

getRoute in interface RouteOuterClass.RouteOrBuilder

getRouteOrBuilder
```
public RouteOuterClass.RouteActionOrBuilder getRouteOrBuilder()
```
```
 Route request to some upstream cluster.
 
```
.envoy.api.v2.route.RouteAction route = 2;
Specified by:

getRouteOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasRedirect
```
public boolean hasRedirect()
```
```
 Return a redirect.
 
```
.envoy.api.v2.route.RedirectAction redirect = 3;
Specified by:

hasRedirect in interface RouteOuterClass.RouteOrBuilder

getRedirect
```
public RouteOuterClass.RedirectAction getRedirect()
```
```
 Return a redirect.
 
```
.envoy.api.v2.route.RedirectAction redirect = 3;
Specified by:

getRedirect in interface RouteOuterClass.RouteOrBuilder

getRedirectOrBuilder
```
public RouteOuterClass.RedirectActionOrBuilder getRedirectOrBuilder()
```
```
 Return a redirect.
 
```
.envoy.api.v2.route.RedirectAction redirect = 3;
Specified by:

getRedirectOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasDirectResponse
```
public boolean hasDirectResponse()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.api.v2.route.DirectResponseAction direct_response = 7;
Specified by:

hasDirectResponse in interface RouteOuterClass.RouteOrBuilder

getDirectResponse
```
public RouteOuterClass.DirectResponseAction getDirectResponse()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.api.v2.route.DirectResponseAction direct_response = 7;
Specified by:

getDirectResponse in interface RouteOuterClass.RouteOrBuilder

getDirectResponseOrBuilder
```
public RouteOuterClass.DirectResponseActionOrBuilder getDirectResponseOrBuilder()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.api.v2.route.DirectResponseAction direct_response = 7;
Specified by:

getDirectResponseOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasMetadata

public boolean hasMetadata()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as *envoy.router*.

.envoy.api.v2.core.Metadata metadata = 4;

Specified by:: hasMetadata in interface RouteOuterClass.RouteOrBuilder

getMetadata

public Base.Metadata getMetadata()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as *envoy.router*.

.envoy.api.v2.core.Metadata metadata = 4;

Specified by:: getMetadata in interface RouteOuterClass.RouteOrBuilder

getMetadataOrBuilder

public Base.MetadataOrBuilder getMetadataOrBuilder()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as *envoy.router*.

.envoy.api.v2.core.Metadata metadata = 4;

Specified by:: getMetadataOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasDecorator
```
public boolean hasDecorator()
```
```
 Decorator for the matched route.
 
```
.envoy.api.v2.route.Decorator decorator = 5;
Specified by:

hasDecorator in interface RouteOuterClass.RouteOrBuilder

getDecorator
```
public RouteOuterClass.Decorator getDecorator()
```
```
 Decorator for the matched route.
 
```
.envoy.api.v2.route.Decorator decorator = 5;
Specified by:

getDecorator in interface RouteOuterClass.RouteOrBuilder

getDecoratorOrBuilder
```
public RouteOuterClass.DecoratorOrBuilder getDecoratorOrBuilder()
```
```
 Decorator for the matched route.
 
```
.envoy.api.v2.route.Decorator decorator = 5;
Specified by:

getDecoratorOrBuilder in interface RouteOuterClass.RouteOrBuilder

hasAuth
```
public boolean hasAuth()
```
```
 [#not-implemented-hide:]
 Return a 401/403 when auth checks fail.
 
```
.envoy.api.v2.auth.AuthAction auth = 6;
Specified by:

hasAuth in interface RouteOuterClass.RouteOrBuilder

getAuth

public Auth.AuthAction getAuth()

 [#not-implemented-hide:]
 Return a 401/403 when auth checks fail.

.envoy.api.v2.auth.AuthAction auth = 6;

Specified by:: getAuth in interface RouteOuterClass.RouteOrBuilder

getAuthOrBuilder

public Auth.AuthActionOrBuilder getAuthOrBuilder()

 [#not-implemented-hide:]
 Return a 401/403 when auth checks fail.

.envoy.api.v2.auth.AuthAction auth = 6;

Specified by:: getAuthOrBuilder in interface RouteOuterClass.RouteOrBuilder