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
,java.io.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 typeenvoy.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.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
-
-
Field Summary
Fields Modifier and Type Field Description private static ScopedRoutes.ScopeKeyBuilder
DEFAULT_INSTANCE
private java.util.List<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder>
fragments_
static int
FRAGMENTS_FIELD_NUMBER
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder>
PARSER
private static long
serialVersionUID
-
Constructor Summary
Constructors Modifier Constructor Description private
ScopeKeyBuilder()
private
ScopeKeyBuilder(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 ScopedRoutes.ScopeKeyBuilder
getDefaultInstance()
ScopedRoutes.ScopeKeyBuilder
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
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>`.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>`.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>`.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>`.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>`.com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder>
getParserForType()
int
getSerializedSize()
int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ScopedRoutes.ScopeKeyBuilder.Builder
newBuilder()
static ScopedRoutes.ScopeKeyBuilder.Builder
newBuilder(ScopedRoutes.ScopeKeyBuilder prototype)
ScopedRoutes.ScopeKeyBuilder.Builder
newBuilderForType()
protected ScopedRoutes.ScopeKeyBuilder.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ScopedRoutes.ScopeKeyBuilder
parseDelimitedFrom(java.io.InputStream input)
static ScopedRoutes.ScopeKeyBuilder
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(byte[] data)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(com.google.protobuf.ByteString data)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(com.google.protobuf.CodedInputStream input)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(java.io.InputStream input)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(java.nio.ByteBuffer data)
static ScopedRoutes.ScopeKeyBuilder
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder>
parser()
ScopedRoutes.ScopeKeyBuilder.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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
FRAGMENTS_FIELD_NUMBER
public static final int FRAGMENTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
fragments_
private java.util.List<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder> fragments_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final ScopedRoutes.ScopeKeyBuilder DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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 interfaceScopedRoutes.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 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_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 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_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 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_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 interfaceScopedRoutes.ScopeKeyBuilderOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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 interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in 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:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ScopedRoutes.ScopeKeyBuilder.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public ScopedRoutes.ScopeKeyBuilder getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-