Class ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor
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.FragmentBuilder.HeaderValueExtractor
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
,Serializable
- Enclosing class:
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder
public static final class ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor
extends com.google.protobuf.GeneratedMessage
implements ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
Specifies how the value of a header should be extracted. The following example maps the structure of a header to the fields in this message. .. code:: <0> <1> <-- index X-Header: a=b;c=d | || | | || \----> <element_separator> | || | |\----> <element.separator> | | | \----> <element.key> | \----> <name> Each 'a=b' key-value pair constitutes an 'element' of the header field.Protobuf type
envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Specifies how the value of a header should be extracted.static enum
static final class
Specifies a header field's key value pair to match on.static interface
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor
static final int
static final int
private Object
private Object
private int
static final int
private byte
private Object
static final int
private static final com.google.protobuf.Parser
<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
HeaderValueExtractor
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static final com.google.protobuf.Descriptors.Descriptor
Specifies the key value pair to extract the value from.Specifies the key value pair to extract the value from.The element separator (e.g., ';' separates 'a;b;c;d').com.google.protobuf.ByteString
The element separator (e.g., ';' separates 'a;b;c;d').int
getIndex()
Specifies the zero based index of the element to extract.getName()
The name of the header field to extract the value from.com.google.protobuf.ByteString
The name of the header field to extract the value from.com.google.protobuf.Parser
<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> int
boolean
Specifies the key value pair to extract the value from.int
hashCode()
boolean
hasIndex()
Specifies the zero based index of the element to extract.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom
(InputStream input) parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(byte[] data) parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.ByteString data) parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.CodedInputStream input) parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(InputStream input) parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(ByteBuffer data) parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> parser()
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
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
extractTypeCase_
private int extractTypeCase_ -
extractType_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
ELEMENT_SEPARATOR_FIELD_NUMBER
public static final int ELEMENT_SEPARATOR_FIELD_NUMBER- See Also:
-
elementSeparator_
-
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER- See Also:
-
ELEMENT_FIELD_NUMBER
public static final int ELEMENT_FIELD_NUMBER- See Also:
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
private static final ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor DEFAULT_INSTANCE -
PARSER
private static final com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> PARSER
-
-
Constructor Details
-
HeaderValueExtractor
private HeaderValueExtractor(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
HeaderValueExtractor
private HeaderValueExtractor()
-
-
Method Details
-
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
-
getExtractTypeCase
public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.ExtractTypeCase getExtractTypeCase()- Specified by:
getExtractTypeCase
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
-
getName
The name of the header field to extract the value from. .. note:: If the header appears multiple times only the first value is used.
string name = 1 [(.validate.rules) = { ... }
- Specified by:
getName
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The name of the header field to extract the value from. .. note:: If the header appears multiple times only the first value is used.
string name = 1 [(.validate.rules) = { ... }
- Specified by:
getNameBytes
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The bytes for name.
-
getElementSeparator
The element separator (e.g., ';' separates 'a;b;c;d'). Default: empty string. This causes the entirety of the header field to be extracted. If this field is set to an empty string and 'index' is used in the oneof below, 'index' must be set to 0.
string element_separator = 2;
- Specified by:
getElementSeparator
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The elementSeparator.
-
getElementSeparatorBytes
public com.google.protobuf.ByteString getElementSeparatorBytes()The element separator (e.g., ';' separates 'a;b;c;d'). Default: empty string. This causes the entirety of the header field to be extracted. If this field is set to an empty string and 'index' is used in the oneof below, 'index' must be set to 0.
string element_separator = 2;
- Specified by:
getElementSeparatorBytes
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The bytes for elementSeparator.
-
hasIndex
public boolean hasIndex()Specifies the zero based index of the element to extract. Note Envoy concatenates multiple values of the same header key into a comma separated string, the splitting always happens after the concatenation.
uint32 index = 3;
- Specified by:
hasIndex
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- Whether the index field is set.
-
getIndex
public int getIndex()Specifies the zero based index of the element to extract. Note Envoy concatenates multiple values of the same header key into a comma separated string, the splitting always happens after the concatenation.
uint32 index = 3;
- Specified by:
getIndex
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The index.
-
hasElement
public boolean hasElement()Specifies the key value pair to extract the value from.
.envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;
- Specified by:
hasElement
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- Whether the element field is set.
-
getElement
Specifies the key value pair to extract the value from.
.envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;
- Specified by:
getElement
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
- Returns:
- The element.
-
getElementOrBuilder
public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElementOrBuilder getElementOrBuilder()Specifies the key value pair to extract the value from.
.envoy.extensions.filters.network.http_connection_manager.v3.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;
- Specified by:
getElementOrBuilder
in interfaceScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- 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.FragmentBuilder.HeaderValueExtractor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor 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.FragmentBuilder.HeaderValueExtractor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder newBuilderForType()- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder newBuilder() -
newBuilder
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder newBuilder(ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor prototype) -
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor getDefaultInstance() -
parser
public static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> parser() -
getParserForType
public com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor> 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.FragmentBuilder.HeaderValueExtractor getDefaultInstanceForType()- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-