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

Class ScopedRoutes.ScopeKeyBuilder.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScopedRoutes.ScopeKeyBuilderOrBuilder, java.lang.Cloneable
    Enclosing class:
    ScopedRoutes.ScopeKeyBuilder
    public static final class ScopedRoutes.ScopeKeyBuilder.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ScopedRoutes.ScopeKeyBuilder.Builder>
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

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • 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.Builder<ScopedRoutes.ScopeKeyBuilder.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ScopedRoutes.ScopeKeyBuilder.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ScopedRoutes.ScopeKeyBuilder.Builder>

      • mergeFrom

        public ScopedRoutes.ScopeKeyBuilder.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ScopedRoutes.ScopeKeyBuilder.Builder>
        Throws:
        java.io.IOException

      • ensureFragmentsIsMutable

        private void ensureFragmentsIsMutable()

      • 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

      • 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

      • setFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder setFragments​(int index,
                                                         ScopedRoutes.ScopeKeyBuilder.FragmentBuilder value)
         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) = { ... }

      • setFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder setFragments​(int index,
                                                         ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder builderForValue)
         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) = { ... }

      • addFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder addFragments​(ScopedRoutes.ScopeKeyBuilder.FragmentBuilder value)
         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) = { ... }

      • addFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder addFragments​(int index,
                                                         ScopedRoutes.ScopeKeyBuilder.FragmentBuilder value)
         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) = { ... }

      • addFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder addFragments​(ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder builderForValue)
         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) = { ... }

      • addFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder addFragments​(int index,
                                                         ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder builderForValue)
         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) = { ... }

      • addAllFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder addAllFragments​(java.lang.Iterable<? extends ScopedRoutes.ScopeKeyBuilder.FragmentBuilder> values)
         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) = { ... }

      • clearFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder clearFragments()
         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) = { ... }

      • removeFragments

        public ScopedRoutes.ScopeKeyBuilder.Builder removeFragments​(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) = { ... }

      • getFragmentsBuilder

        public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder getFragmentsBuilder​(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) = { ... }

      • 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

      • 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

      • addFragmentsBuilder

        public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder addFragmentsBuilder()
         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) = { ... }

      • addFragmentsBuilder

        public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder addFragmentsBuilder​(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) = { ... }

      • getFragmentsBuilderList

        public java.util.List<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.Builder> getFragmentsBuilderList()
         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) = { ... }