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 type
envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder| Modifier and Type | Class and 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 |
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| Modifier and Type | Field and Description |
|---|---|
static int |
FRAGMENTS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(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_api_msg_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_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.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>`.
|
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() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ScopedRoutes.ScopeKeyBuilder |
parseDelimitedFrom(InputStream input) |
static ScopedRoutes.ScopeKeyBuilder |
parseDelimitedFrom(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(ByteBuffer data) |
static ScopedRoutes.ScopeKeyBuilder |
parseFrom(ByteBuffer 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(InputStream input) |
static ScopedRoutes.ScopeKeyBuilder |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder> |
parser() |
ScopedRoutes.ScopeKeyBuilder.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int FRAGMENTS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }getFragmentsList in interface ScopedRoutes.ScopeKeyBuilderOrBuilderpublic 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) = { ... }getFragmentsOrBuilderList in interface ScopedRoutes.ScopeKeyBuilderOrBuilderpublic 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) = { ... }getFragmentsCount in interface ScopedRoutes.ScopeKeyBuilderOrBuilderpublic 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) = { ... }getFragments in interface ScopedRoutes.ScopeKeyBuilderOrBuilderpublic 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) = { ... }getFragmentsOrBuilder in interface ScopedRoutes.ScopeKeyBuilderOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ScopedRoutes.ScopeKeyBuilder parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(InputStream input) throws IOException
IOExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ScopedRoutes.ScopeKeyBuilder parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ScopedRoutes.ScopeKeyBuilder.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ScopedRoutes.ScopeKeyBuilder.Builder newBuilder()
public static ScopedRoutes.ScopeKeyBuilder.Builder newBuilder(ScopedRoutes.ScopeKeyBuilder prototype)
public ScopedRoutes.ScopeKeyBuilder.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ScopedRoutes.ScopeKeyBuilder.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ScopedRoutes.ScopeKeyBuilder getDefaultInstance()
public static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder> parser()
public com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ScopedRoutes.ScopeKeyBuilder getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.