Class ScopedRoutes.ScopeKeyBuilder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.envoyproxy.envoy.config.filter.network.http_connection_manager.v2.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.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_api_msg_ScopedRouteConfiguration.Key>` objects assembled from :ref:`ScopedRouteConfiguration<envoy_api_msg_ScopedRouteConfiguration>` messages distributed via SRDS (the Scoped Route Discovery Service) or assigned statically via :ref:`scoped_route_configurations_list<envoy_api_field_config.filter.network.http_connection_manager.v2.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_api_msg_RouteConfiguration>`) to use for the request.
Protobuf typeenvoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classScopedRoutes.ScopeKeyBuilder.BuilderSpecifies the mechanism for constructing "scope keys" based on HTTP request attributes.static classScopedRoutes.ScopeKeyBuilder.FragmentBuilderSpecifies the mechanism for constructing key fragments which are composed into scope keys.static interfaceScopedRoutes.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
-
-
Field Summary
Fields Modifier and Type Field Description static intFRAGMENTS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)static ScopedRoutes.ScopeKeyBuildergetDefaultInstance()ScopedRoutes.ScopeKeyBuildergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()ScopedRoutes.ScopeKeyBuilder.FragmentBuildergetFragments(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_api_msg_ScopedRouteConfiguration>`.intgetFragmentsCount()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_api_msg_ScopedRouteConfiguration>`.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_api_msg_ScopedRouteConfiguration>`.ScopedRoutes.ScopeKeyBuilder.FragmentBuilderOrBuildergetFragmentsOrBuilder(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_api_msg_ScopedRouteConfiguration>`.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_api_msg_ScopedRouteConfiguration>`.com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder>getParserForType()intgetSerializedSize()com.google.protobuf.UnknownFieldSetgetUnknownFields()inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static ScopedRoutes.ScopeKeyBuilder.BuildernewBuilder()static ScopedRoutes.ScopeKeyBuilder.BuildernewBuilder(ScopedRoutes.ScopeKeyBuilder prototype)ScopedRoutes.ScopeKeyBuilder.BuildernewBuilderForType()protected ScopedRoutes.ScopeKeyBuilder.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static ScopedRoutes.ScopeKeyBuilderparseDelimitedFrom(InputStream input)static ScopedRoutes.ScopeKeyBuilderparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ScopedRoutes.ScopeKeyBuilderparseFrom(byte[] data)static ScopedRoutes.ScopeKeyBuilderparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ScopedRoutes.ScopeKeyBuilderparseFrom(com.google.protobuf.ByteString data)static ScopedRoutes.ScopeKeyBuilderparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ScopedRoutes.ScopeKeyBuilderparseFrom(com.google.protobuf.CodedInputStream input)static ScopedRoutes.ScopeKeyBuilderparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ScopedRoutes.ScopeKeyBuilderparseFrom(InputStream input)static ScopedRoutes.ScopeKeyBuilderparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ScopedRoutes.ScopeKeyBuilderparseFrom(ByteBuffer data)static ScopedRoutes.ScopeKeyBuilderparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder>parser()ScopedRoutes.ScopeKeyBuilder.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
FRAGMENTS_FIELD_NUMBER
public static final int FRAGMENTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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_api_msg_ScopedRouteConfiguration>`. A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
repeated .envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }- Specified by:
getFragmentsListin interfaceScopedRoutes.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_api_msg_ScopedRouteConfiguration>`. A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
repeated .envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }- Specified by:
getFragmentsOrBuilderListin interfaceScopedRoutes.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_api_msg_ScopedRouteConfiguration>`. A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
repeated .envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }- Specified by:
getFragmentsCountin interfaceScopedRoutes.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_api_msg_ScopedRouteConfiguration>`. A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
repeated .envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }- Specified by:
getFragmentsin interfaceScopedRoutes.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_api_msg_ScopedRouteConfiguration>`. A missing fragment during comparison will make the key invalid, i.e., the computed key doesn't match any key.
repeated .envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder fragments = 1 [(.validate.rules) = { ... }- Specified by:
getFragmentsOrBuilderin interfaceScopedRoutes.ScopeKeyBuilderOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ScopedRoutes.ScopeKeyBuilder.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public ScopedRoutes.ScopeKeyBuilder getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-