Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class ScopedRoutes.ScopeKeyBuilder

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScopedRoutes.ScopeKeyBuilderOrBuilder, java.io.Serializable
    Enclosing class:
    ScopedRoutes
    public static final class ScopedRoutes.ScopeKeyBuilder
extends com.google.protobuf.GeneratedMessageV3
implements ScopedRoutes.ScopeKeyBuilderOrBuilder
     Specifies the mechanism for constructing "scope keys" based on HTTP request attributes. These
 keys are matched against a set of :ref:`Key<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration.Key>`
 objects assembled from :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`
 messages distributed via SRDS (the Scoped Route Discovery Service) or assigned statically via
 :ref:`scoped_route_configurations_list<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scoped_route_configurations_list>`.
 Upon receiving a request's headers, the Router will build a key using the algorithm specified
 by this message. This key will be used to look up the routing table (i.e., the
 :ref:`RouteConfiguration<envoy_v3_api_msg_config.route.v3.RouteConfiguration>`) to use for the request.
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ScopedRoutes.ScopeKeyBuilder.Builder
      Specifies the mechanism for constructing "scope keys" based on HTTP request attributes.
      static class  ScopedRoutes.ScopeKeyBuilder.FragmentBuilder
      Specifies the mechanism for constructing key fragments which are composed into scope keys.
      static interface  ScopedRoutes.ScopeKeyBuilder.FragmentBuilderOrBuilder  

      • 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 FRAGMENTS_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

    • Field Detail

    • 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

      • getFragmentsList

        public java.util.List<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder> getFragmentsList()
         The final(built) scope key consists of the ordered union of these fragments, which are compared in order with the
 fragments of a :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`.
 A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }
        Specified by:
        getFragmentsList in interface ScopedRoutes.ScopeKeyBuilderOrBuilder

      • getFragmentsOrBuilderList

        public java.util.List<? extends ScopedRoutes.ScopeKeyBuilder.FragmentBuilderOrBuilder> getFragmentsOrBuilderList()
         The final(built) scope key consists of the ordered union of these fragments, which are compared in order with the
 fragments of a :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`.
 A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }
        Specified by:
        getFragmentsOrBuilderList in interface ScopedRoutes.ScopeKeyBuilderOrBuilder

      • getFragmentsCount

        public int getFragmentsCount()
         The final(built) scope key consists of the ordered union of these fragments, which are compared in order with the
 fragments of a :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`.
 A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }
        Specified by:
        getFragmentsCount in interface ScopedRoutes.ScopeKeyBuilderOrBuilder

      • getFragments

        public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder getFragments​(int index)
         The final(built) scope key consists of the ordered union of these fragments, which are compared in order with the
 fragments of a :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`.
 A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }
        Specified by:
        getFragments in interface ScopedRoutes.ScopeKeyBuilderOrBuilder

      • getFragmentsOrBuilder

        public ScopedRoutes.ScopeKeyBuilder.FragmentBuilderOrBuilder getFragmentsOrBuilder​(int index)
         The final(built) scope key consists of the ordered union of these fragments, which are compared in order with the
 fragments of a :ref:`ScopedRouteConfiguration<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration>`.
 A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
        repeated .envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }
        Specified by:
        getFragmentsOrBuilder in interface ScopedRoutes.ScopeKeyBuilderOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(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 ScopedRoutes.ScopeKeyBuilder parseFrom​(java.nio.ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScopedRoutes.ScopeKeyBuilder parseFrom​(java.nio.ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static ScopedRoutes.ScopeKeyBuilder parseFrom​(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScopedRoutes.ScopeKeyBuilder parseFrom​(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static ScopedRoutes.ScopeKeyBuilder parseFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static ScopedRoutes.ScopeKeyBuilder parseDelimitedFrom​(java.io.InputStream input)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static ScopedRoutes.ScopeKeyBuilder parseFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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