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

Class ScopedRoutes.ScopeKeyBuilder

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScopedRoutes.ScopeKeyBuilderOrBuilder, Serializable
Enclosing class:
ScopedRoutes
public static final class ScopedRoutes.ScopeKeyBuilder extends com.google.protobuf.GeneratedMessage 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:

  • Field Details

  • Constructor Details

    • ScopeKeyBuilder

      private ScopeKeyBuilder(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • ScopeKeyBuilder

      private ScopeKeyBuilder()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getFragmentsList

      public 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 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.GeneratedMessage

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

    • parseFrom

      public static ScopedRoutes.ScopeKeyBuilder parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

      public static ScopedRoutes.ScopeKeyBuilder parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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

    • newBuilder

      public static ScopedRoutes.ScopeKeyBuilder.Builder newBuilder()

    • newBuilder

      public static ScopedRoutes.ScopeKeyBuilder.Builder newBuilder(ScopedRoutes.ScopeKeyBuilder prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ScopedRoutes.ScopeKeyBuilder getDefaultInstance()

    • parser

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

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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