Package io.envoyproxy.envoy.api.v2.route

Class VirtualCluster

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, VirtualClusterOrBuilder, 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 Detail

      • newInstance

        protected 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 String getPattern()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.pattern is deprecated. See envoy/api/v2/route/route_components.proto;l=1328
         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=1328
         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.

      • getHeadersList

        public List<HeaderMatcher> getHeadersList()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;
        Specified by:
        getHeadersList in interface VirtualClusterOrBuilder

      • getHeadersOrBuilderList

        public List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;
        Specified by:
        getHeadersOrBuilderList in interface VirtualClusterOrBuilder

      • getHeadersCount

        public int getHeadersCount()
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;
        Specified by:
        getHeadersCount in interface VirtualClusterOrBuilder

      • getHeaders

        public HeaderMatcher getHeaders​(int index)
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;
        Specified by:
        getHeaders in interface VirtualClusterOrBuilder

      • getHeadersOrBuilder

        public HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
         Specifies a list of header matchers to use for matching requests. Each specified header must
 match. The pseudo-headers `:path` and `:method` can be used to match the request path and
 method, respectively.
        repeated .envoy.api.v2.route.HeaderMatcher headers = 4;
        Specified by:
        getHeadersOrBuilder in interface 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 VirtualClusterOrBuilder
        Returns:
        The name.

      • 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 VirtualClusterOrBuilder
        Returns:
        The bytes for name.

      • getMethodValue

        @Deprecated
public int getMethodValue()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.method is deprecated. See envoy/api/v2/route/route_components.proto;l=1349
         Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 .. attention::
   This field has been deprecated in favor of `headers`.
        .envoy.api.v2.core.RequestMethod method = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getMethodValue in interface VirtualClusterOrBuilder
        Returns:
        The enum numeric value on the wire for method.

      • getMethod

        @Deprecated
public RequestMethod getMethod()
        Deprecated.
        envoy.api.v2.route.VirtualCluster.method is deprecated. See envoy/api/v2/route/route_components.proto;l=1349
         Optionally specifies the HTTP method to match on. For example GET, PUT,
 etc.
 .. attention::
   This field has been deprecated in favor of `headers`.
        .envoy.api.v2.core.RequestMethod method = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getMethod in interface VirtualClusterOrBuilder
        Returns:
        The method.

      • 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 VirtualCluster parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static VirtualCluster parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static 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 VirtualCluster parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

        public VirtualCluster.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public VirtualCluster.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected VirtualCluster.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static VirtualCluster getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<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 VirtualCluster getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder