Class 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.GeneratedMessage
    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.config.route.v3.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.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private VirtualCluster()  
      private VirtualCluster​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete 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.
      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()  
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static VirtualCluster.Builder newBuilder()  
      static VirtualCluster.Builder newBuilder​(VirtualCluster prototype)  
      VirtualCluster.Builder newBuilderForType()  
      protected VirtualCluster.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      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.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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, getUnknownFields, hasField, hasOneof
    • Field Detail

      • name_

        private volatile java.lang.Object name_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final VirtualCluster DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<VirtualCluster> PARSER
    • Constructor Detail

      • VirtualCluster

        private VirtualCluster​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • VirtualCluster

        private VirtualCluster()
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • getHeadersList

        public java.util.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.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersList in interface VirtualClusterOrBuilder
      • getHeadersOrBuilderList

        public java.util.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.config.route.v3.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.config.route.v3.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.config.route.v3.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.config.route.v3.HeaderMatcher headers = 4;
        Specified by:
        getHeadersOrBuilder in interface VirtualClusterOrBuilder
      • getName

        public java.lang.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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VirtualCluster parseFrom​(java.nio.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​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static VirtualCluster parseFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static VirtualCluster parseDelimitedFrom​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static VirtualCluster parseDelimitedFrom​(java.io.InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static VirtualCluster parseFrom​(com.google.protobuf.CodedInputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static VirtualCluster parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

        public VirtualCluster getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder