java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.api.v2.route.VirtualCluster

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, VirtualClusterOrBuilder, java.io.Serializable

public final class VirtualCluster
extends com.google.protobuf.GeneratedMessageV3
implements 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_vcluster_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	Description
`static class`	`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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field Description

static int HEADERS_FIELD_NUMBER

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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`static VirtualCluster`	`getDefaultInstance()`
`VirtualCluster`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`HeaderMatcher`	`getHeaders(int index)`	Specifies a list of header matchers to use for matching requests.
`int`	`getHeadersCount()`	Specifies a list of header matchers to use for matching requests.
`java.util.List<HeaderMatcher>`	`getHeadersList()`	Specifies a list of header matchers to use for matching requests.
`HeaderMatcherOrBuilder`	`getHeadersOrBuilder(int index)`	Specifies a list of header matchers to use for matching requests.
`java.util.List<? extends HeaderMatcherOrBuilder>`	`getHeadersOrBuilderList()`	Specifies a list of header matchers to use for matching requests.
`RequestMethod`	`getMethod()`	Deprecated. envoy.api.v2.route.VirtualCluster.method is deprecated.
`int`	`getMethodValue()`	Deprecated. envoy.api.v2.route.VirtualCluster.method is deprecated.
`java.lang.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<VirtualCluster>`	`getParserForType()`
`java.lang.String`	`getPattern()`	Deprecated. envoy.api.v2.route.VirtualCluster.pattern is deprecated.
`com.google.protobuf.ByteString`	`getPatternBytes()`	Deprecated. envoy.api.v2.route.VirtualCluster.pattern is deprecated.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static VirtualCluster.Builder`	`newBuilder()`
`static VirtualCluster.Builder`	`newBuilder(VirtualCluster prototype)`
`VirtualCluster.Builder`	`newBuilderForType()`
`protected VirtualCluster.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static VirtualCluster`	`parseDelimitedFrom(java.io.InputStream input)`
`static VirtualCluster`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static VirtualCluster`	`parseFrom(byte[] data)`
`static VirtualCluster`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static VirtualCluster`	`parseFrom(com.google.protobuf.ByteString data)`
`static VirtualCluster`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static VirtualCluster`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static VirtualCluster`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static VirtualCluster`	`parseFrom(java.io.InputStream input)`
`static VirtualCluster`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static VirtualCluster`	`parseFrom(java.nio.ByteBuffer data)`
`static VirtualCluster`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<VirtualCluster>`	`parser()`
`VirtualCluster.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

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

Field Detail
- PATTERN_FIELD_NUMBER
```
public static final int PATTERN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_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

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

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

@Deprecated
public java.lang.String getPattern()

Deprecated.

envoy.api.v2.route.VirtualCluster.pattern is deprecated. See envoy/api/v2/route/route_components.proto;l=1329

 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
 <https://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*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

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

Specified by:: getPattern in interface VirtualClusterOrBuilder
Returns:: The pattern.

getPatternBytes

@Deprecated
public com.google.protobuf.ByteString getPatternBytes()

Deprecated.

envoy.api.v2.route.VirtualCluster.pattern is deprecated. See envoy/api/v2/route/route_components.proto;l=1329

 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
 <https://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*
 .. attention::
   This field has been deprecated in favor of `headers` as it is not safe for use with
   untrusted input in all cases.

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

Specified by:: getPatternBytes in interface VirtualClusterOrBuilder
Returns:: The bytes for pattern.