envoy.api.v2.route

Class RouteOuterClass.VirtualCluster

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.api.v2.route.RouteOuterClass.VirtualCluster

All Implemented Interfaces:

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

Enclosing class:

RouteOuterClass

public static final class RouteOuterClass.VirtualCluster
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.VirtualClusterOrBuilder

 A virtual cluster is a way of specifying a regex matching rule against
 certain important endpoints such that statistics are generated explicitly for
 the matched requests. The reason this is useful is that when doing
 prefix/path matching Envoy does not always know what the application
 considers to be an endpoint. Thus, it’s impossible for Envoy to generically
 emit per endpoint statistics. However, often systems have highly critical
 endpoints that they wish to get “perfect” statistics on. Virtual cluster
 statistics are perfect in the sense that they are emitted on the downstream
 side such that they include network level failures.
 Documentation for :ref:`virtual cluster statistics <config_http_filters_router_stats>`.
 .. note::
    Virtual clusters are a useful tool, but we do not recommend setting up a virtual cluster for
    every application endpoint. This is both not easily maintainable and as well the matching and
    statistics output are not free.
 

Protobuf type envoy.api.v2.route.VirtualCluster

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteOuterClass.VirtualCluster.Builder A virtual cluster is a way of specifying a regex matching rule against certain important endpoints such that statistics are generated explicitly for the matched requests.

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	METHOD_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PATTERN_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
static RouteOuterClass.VirtualCluster	getDefaultInstance()
RouteOuterClass.VirtualCluster	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Base.RequestMethod	getMethod() Optionally specifies the HTTP method to match on.
int	getMethodValue() Optionally specifies the HTTP method to match on.
String	getName() Specifies the name of the virtual cluster.
com.google.protobuf.ByteString	getNameBytes() Specifies the name of the virtual cluster.
com.google.protobuf.Parser<RouteOuterClass.VirtualCluster>	getParserForType()
String	getPattern() Specifies a regex pattern to use for matching requests.
com.google.protobuf.ByteString	getPatternBytes() Specifies a regex pattern to use for matching requests.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RouteOuterClass.VirtualCluster.Builder	newBuilder()
static RouteOuterClass.VirtualCluster.Builder	newBuilder(RouteOuterClass.VirtualCluster prototype)
RouteOuterClass.VirtualCluster.Builder	newBuilderForType()
protected RouteOuterClass.VirtualCluster.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RouteOuterClass.VirtualCluster	parseDelimitedFrom(InputStream input)
static RouteOuterClass.VirtualCluster	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.VirtualCluster	parseFrom(byte[] data)
static RouteOuterClass.VirtualCluster	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.VirtualCluster	parseFrom(ByteBuffer data)
static RouteOuterClass.VirtualCluster	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.VirtualCluster	parseFrom(com.google.protobuf.ByteString data)
static RouteOuterClass.VirtualCluster	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.VirtualCluster	parseFrom(com.google.protobuf.CodedInputStream input)
static RouteOuterClass.VirtualCluster	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.VirtualCluster	parseFrom(InputStream input)
static RouteOuterClass.VirtualCluster	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RouteOuterClass.VirtualCluster>	parser()
RouteOuterClass.VirtualCluster.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

PATTERN_FIELD_NUMBER

public static final int PATTERN_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

METHOD_FIELD_NUMBER

public static final int METHOD_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

getPattern

public String getPattern()

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex */rides/\d+* matches the path */rides/0*
 * The regex */rides/\d+* matches the path */rides/123*
 * The regex */rides/\d+* does not match the path */rides/123/456*
 

string pattern = 1 [(.validate.rules) = { ... }

Specified by:

getPattern in interface RouteOuterClass.VirtualClusterOrBuilder

getPatternBytes

public com.google.protobuf.ByteString getPatternBytes()

 Specifies a regex pattern to use for matching requests. The entire path of the request
 must match the regex. The regex grammar used is defined `here
 <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex */rides/\d+* matches the path */rides/0*
 * The regex */rides/\d+* matches the path */rides/123*
 * The regex */rides/\d+* does not match the path */rides/123/456*
 

string pattern = 1 [(.validate.rules) = { ... }

Specified by:

getPatternBytes in interface RouteOuterClass.VirtualClusterOrBuilder

getName

public String getName()

  Specifies the name of the virtual cluster. The virtual cluster name as well
 as the virtual host name are used when emitting statistics. The statistics are emitted by the
 router filter and are documented :ref:`here <config_http_filters_router_stats>`.
 

string name = 2 [(.validate.rules) = { ... }

Specified by:

getName in interface RouteOuterClass.VirtualClusterOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

  Specifies the name of the virtual cluster. The virtual cluster name as well
 as the virtual host name are used when emitting statistics. The statistics are emitted by the
 router filter and are documented :ref:`here <config_http_filters_router_stats>`.
 

string name = 2 [(.validate.rules) = { ... }

Specified by:

getNameBytes in interface RouteOuterClass.VirtualClusterOrBuilder

getMethodValue

public int getMethodValue()

 Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
 

.envoy.api.v2.core.RequestMethod method = 3;

Specified by:

getMethodValue in interface RouteOuterClass.VirtualClusterOrBuilder

getMethod

public Base.RequestMethod getMethod()

 Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
 

.envoy.api.v2.core.RequestMethod method = 3;

Specified by:

getMethod in interface RouteOuterClass.VirtualClusterOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static RouteOuterClass.VirtualCluster parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static RouteOuterClass.VirtualCluster parseDelimitedFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.VirtualCluster parseFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public RouteOuterClass.VirtualCluster.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RouteOuterClass.VirtualCluster.Builder newBuilder()

newBuilder

public static RouteOuterClass.VirtualCluster.Builder newBuilder(RouteOuterClass.VirtualCluster prototype)

toBuilder

public RouteOuterClass.VirtualCluster.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RouteOuterClass.VirtualCluster.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RouteOuterClass.VirtualCluster getDefaultInstance()

parser

public static com.google.protobuf.Parser<RouteOuterClass.VirtualCluster> parser()

getParserForType

public com.google.protobuf.Parser<RouteOuterClass.VirtualCluster> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RouteOuterClass.VirtualCluster getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder