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| 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>`.
|
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| 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 |
| 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) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int MATCH_FIELD_NUMBER
public static final int ROUTE_FIELD_NUMBER
public static final int REDIRECT_FIELD_NUMBER
public static final int DIRECT_RESPONSE_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int DECORATOR_FIELD_NUMBER
public static final int AUTH_FIELD_NUMBER
public static final int PER_FILTER_CONFIG_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public RouteOuterClass.Route.ActionCase getActionCase()
getActionCase in interface RouteOuterClass.RouteOrBuilderpublic boolean hasMatch()
Route matching parameters.
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }hasMatch in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RouteMatch getMatch()
Route matching parameters.
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getMatch in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RouteMatchOrBuilder getMatchOrBuilder()
Route matching parameters.
.envoy.api.v2.route.RouteMatch match = 1 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getMatchOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic boolean hasRoute()
Route request to some upstream cluster.
.envoy.api.v2.route.RouteAction route = 2;hasRoute in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RouteAction getRoute()
Route request to some upstream cluster.
.envoy.api.v2.route.RouteAction route = 2;getRoute in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RouteActionOrBuilder getRouteOrBuilder()
Route request to some upstream cluster.
.envoy.api.v2.route.RouteAction route = 2;getRouteOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic boolean hasRedirect()
Return a redirect.
.envoy.api.v2.route.RedirectAction redirect = 3;hasRedirect in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RedirectAction getRedirect()
Return a redirect.
.envoy.api.v2.route.RedirectAction redirect = 3;getRedirect in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.RedirectActionOrBuilder getRedirectOrBuilder()
Return a redirect.
.envoy.api.v2.route.RedirectAction redirect = 3;getRedirectOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic boolean hasDirectResponse()
Return an arbitrary HTTP response directly, without proxying.
.envoy.api.v2.route.DirectResponseAction direct_response = 7;hasDirectResponse in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.DirectResponseAction getDirectResponse()
Return an arbitrary HTTP response directly, without proxying.
.envoy.api.v2.route.DirectResponseAction direct_response = 7;getDirectResponse in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.DirectResponseActionOrBuilder getDirectResponseOrBuilder()
Return an arbitrary HTTP response directly, without proxying.
.envoy.api.v2.route.DirectResponseAction direct_response = 7;getDirectResponseOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic 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;hasMetadata in interface RouteOuterClass.RouteOrBuilderpublic 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;getMetadata in interface RouteOuterClass.RouteOrBuilderpublic 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;getMetadataOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic boolean hasDecorator()
Decorator for the matched route.
.envoy.api.v2.route.Decorator decorator = 5;hasDecorator in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.Decorator getDecorator()
Decorator for the matched route.
.envoy.api.v2.route.Decorator decorator = 5;getDecorator in interface RouteOuterClass.RouteOrBuilderpublic RouteOuterClass.DecoratorOrBuilder getDecoratorOrBuilder()
Decorator for the matched route.
.envoy.api.v2.route.Decorator decorator = 5;getDecoratorOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic boolean hasAuth()
[#not-implemented-hide:] Return a 401/403 when auth checks fail.
.envoy.api.v2.auth.AuthAction auth = 6;hasAuth in interface RouteOuterClass.RouteOrBuilderpublic Auth.AuthAction getAuth()
[#not-implemented-hide:] Return a 401/403 when auth checks fail.
.envoy.api.v2.auth.AuthAction auth = 6;getAuth in interface RouteOuterClass.RouteOrBuilderpublic Auth.AuthActionOrBuilder getAuthOrBuilder()
[#not-implemented-hide:] Return a 401/403 when auth checks fail.
.envoy.api.v2.auth.AuthAction auth = 6;getAuthOrBuilder in interface RouteOuterClass.RouteOrBuilderpublic int getPerFilterConfigCount()
RouteOuterClass.RouteOrBuilderThe per_filter_config field can be used to provide route-specific configurations for filters. The key should match the filter name, such as *envoy.buffer* for the HTTP buffer filter. Use of this field is filter specific; see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
map<string, .google.protobuf.Struct> per_filter_config = 8;getPerFilterConfigCount in interface RouteOuterClass.RouteOrBuilderpublic boolean containsPerFilterConfig(String key)
The per_filter_config field can be used to provide route-specific configurations for filters. The key should match the filter name, such as *envoy.buffer* for the HTTP buffer filter. Use of this field is filter specific; see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
map<string, .google.protobuf.Struct> per_filter_config = 8;containsPerFilterConfig in interface RouteOuterClass.RouteOrBuilder@Deprecated public Map<String,com.google.protobuf.Struct> getPerFilterConfig()
getPerFilterConfigMap() instead.getPerFilterConfig in interface RouteOuterClass.RouteOrBuilderpublic Map<String,com.google.protobuf.Struct> getPerFilterConfigMap()
The per_filter_config field can be used to provide route-specific configurations for filters. The key should match the filter name, such as *envoy.buffer* for the HTTP buffer filter. Use of this field is filter specific; see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
map<string, .google.protobuf.Struct> per_filter_config = 8;getPerFilterConfigMap in interface RouteOuterClass.RouteOrBuilderpublic 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. The key should match the filter name, such as *envoy.buffer* for the HTTP buffer filter. Use of this field is filter specific; see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
map<string, .google.protobuf.Struct> per_filter_config = 8;getPerFilterConfigOrDefault in interface RouteOuterClass.RouteOrBuilderpublic com.google.protobuf.Struct getPerFilterConfigOrThrow(String key)
The per_filter_config field can be used to provide route-specific configurations for filters. The key should match the filter name, such as *envoy.buffer* for the HTTP buffer filter. Use of this field is filter specific; see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
map<string, .google.protobuf.Struct> per_filter_config = 8;getPerFilterConfigOrThrow in interface RouteOuterClass.RouteOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RouteOuterClass.Route parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RouteOuterClass.Route parseFrom(InputStream input) throws IOException
IOExceptionpublic static RouteOuterClass.Route parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RouteOuterClass.Route parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RouteOuterClass.Route parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RouteOuterClass.Route parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RouteOuterClass.Route parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RouteOuterClass.Route.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RouteOuterClass.Route.Builder newBuilder()
public static RouteOuterClass.Route.Builder newBuilder(RouteOuterClass.Route prototype)
public RouteOuterClass.Route.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RouteOuterClass.Route.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RouteOuterClass.Route getDefaultInstance()
public static com.google.protobuf.Parser<RouteOuterClass.Route> parser()
public com.google.protobuf.Parser<RouteOuterClass.Route> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RouteOuterClass.Route getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018 The Envoy Project. All rights reserved.