Package io.envoyproxy.envoy.config.filter.network.http_connection_manager.v2

Class ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor

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.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.GeneratedMessageV3
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.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	Specifies how the value of a header should be extracted.
static enum	ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.ExtractTypeCase
static final class	ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement	Specifies a header field's key value pair to match on.
static interface	ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElementOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ELEMENT_FIELD_NUMBER
static final int	ELEMENT_SEPARATOR_FIELD_NUMBER
static final int	INDEX_FIELD_NUMBER
static final int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	getDefaultInstance()
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement	getElement()	Specifies the key value pair to extract the value from.
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElementOrBuilder	getElementOrBuilder()	Specifies the key value pair to extract the value from.
String	getElementSeparator()	The element separator (e.g., ';' separates 'a;b;c;d').
com.google.protobuf.ByteString	getElementSeparatorBytes()	The element separator (e.g., ';' separates 'a;b;c;d').
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.ExtractTypeCase	getExtractTypeCase()
int	getIndex()	Specifies the zero based index of the element to extract.
String	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.
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.
com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor>	getParserForType()
int	getSerializedSize()
boolean	hasElement()	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.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	newBuilder()
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	newBuilder(ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor prototype)
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	newBuilderForType()
protected ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseDelimitedFrom(InputStream input)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(byte[] data)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(com.google.protobuf.ByteString data)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(com.google.protobuf.CodedInputStream input)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(InputStream input)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(ByteBuffer data)
static ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor>	parser()
ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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

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

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

ELEMENT_SEPARATOR_FIELD_NUMBER

public static final int ELEMENT_SEPARATOR_FIELD_NUMBER

See Also:

• Constant Field Values

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

• Constant Field Values

ELEMENT_FIELD_NUMBER

public static final int ELEMENT_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getExtractTypeCase

public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.ExtractTypeCase getExtractTypeCase()

Specified by:

getExtractTypeCase in interface ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder

getName

public String 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 interface ScopedRoutes.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 interface ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder

Returns:

The bytes for name.

getElementSeparator

public String 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 interface ScopedRoutes.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 interface ScopedRoutes.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 interface ScopedRoutes.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 interface ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder

Returns:

The index.

hasElement

public boolean hasElement()

 Specifies the key value pair to extract the value from.
 

.envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;

Specified by:

hasElement in interface ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder

Returns:

Whether the element field is set.

getElement

public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement getElement()

 Specifies the key value pair to extract the value from.
 

.envoy.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;

Specified by:

getElement in interface ScopedRoutes.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.config.filter.network.http_connection_manager.v2.ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.KvElement element = 4;

Specified by:

getElementOrBuilder in interface ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractorOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.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 interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.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

public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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 interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ScopedRoutes.ScopeKeyBuilder.FragmentBuilder.HeaderValueExtractor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder