io.envoyproxy.envoy.extensions.filters.http.header_to_metadata.v3

Class Config.KeyValuePair

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.KeyValuePairOrBuilder, Serializable

Enclosing class:

Config

public static final class Config.KeyValuePair
extends com.google.protobuf.GeneratedMessageV3
implements Config.KeyValuePairOrBuilder

 [#next-free-field: 7]
 

Protobuf type envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.KeyValuePair.Builder [#next-free-field: 7] Protobuf type envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair

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 and Description
static int	ENCODE_FIELD_NUMBER
static int	KEY_FIELD_NUMBER
static int	METADATA_NAMESPACE_FIELD_NUMBER
static int	REGEX_VALUE_REWRITE_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	VALUE_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 and Description
boolean	equals(Object obj)
static Config.KeyValuePair	getDefaultInstance()
Config.KeyValuePair	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Config.ValueEncode	getEncode() How is the value encoded, default is NONE (not encoded).
int	getEncodeValue() How is the value encoded, default is NONE (not encoded).
String	getKey() The key to use within the namespace.
com.google.protobuf.ByteString	getKeyBytes() The key to use within the namespace.
String	getMetadataNamespace() The namespace — if this is empty, the filter's namespace will be used.
com.google.protobuf.ByteString	getMetadataNamespaceBytes() The namespace — if this is empty, the filter's namespace will be used.
com.google.protobuf.Parser<Config.KeyValuePair>	getParserForType()
RegexMatchAndSubstitute	getRegexValueRewrite() If present, the header's value will be matched and substituted with this.
RegexMatchAndSubstituteOrBuilder	getRegexValueRewriteOrBuilder() If present, the header's value will be matched and substituted with this.
int	getSerializedSize()
Config.ValueType	getType() The value's type — defaults to string.
int	getTypeValue() The value's type — defaults to string.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getValue() The value to pair with the given key.
com.google.protobuf.ByteString	getValueBytes() The value to pair with the given key.
int	hashCode()
boolean	hasRegexValueRewrite() If present, the header's value will be matched and substituted with this.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Config.KeyValuePair.Builder	newBuilder()
static Config.KeyValuePair.Builder	newBuilder(Config.KeyValuePair prototype)
Config.KeyValuePair.Builder	newBuilderForType()
protected Config.KeyValuePair.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Config.KeyValuePair	parseDelimitedFrom(InputStream input)
static Config.KeyValuePair	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.KeyValuePair	parseFrom(byte[] data)
static Config.KeyValuePair	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.KeyValuePair	parseFrom(ByteBuffer data)
static Config.KeyValuePair	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.KeyValuePair	parseFrom(com.google.protobuf.ByteString data)
static Config.KeyValuePair	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.KeyValuePair	parseFrom(com.google.protobuf.CodedInputStream input)
static Config.KeyValuePair	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.KeyValuePair	parseFrom(InputStream input)
static Config.KeyValuePair	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Config.KeyValuePair>	parser()
Config.KeyValuePair.Builder	toBuilder()
void	writeTo(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, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

METADATA_NAMESPACE_FIELD_NUMBER

public static final int METADATA_NAMESPACE_FIELD_NUMBER

See Also:

Constant Field Values

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

REGEX_VALUE_REWRITE_FIELD_NUMBER

public static final int REGEX_VALUE_REWRITE_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

ENCODE_FIELD_NUMBER

public static final int ENCODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

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

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getMetadataNamespace

public String getMetadataNamespace()

 The namespace — if this is empty, the filter's namespace will be used.
 

string metadata_namespace = 1;

Specified by:

getMetadataNamespace in interface Config.KeyValuePairOrBuilder

getMetadataNamespaceBytes

public com.google.protobuf.ByteString getMetadataNamespaceBytes()

 The namespace — if this is empty, the filter's namespace will be used.
 

string metadata_namespace = 1;

Specified by:

getMetadataNamespaceBytes in interface Config.KeyValuePairOrBuilder

getKey

public String getKey()

 The key to use within the namespace.
 

string key = 2 [(.validate.rules) = { ... }

Specified by:

getKey in interface Config.KeyValuePairOrBuilder

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 The key to use within the namespace.
 

string key = 2 [(.validate.rules) = { ... }

Specified by:

getKeyBytes in interface Config.KeyValuePairOrBuilder

getValue

public String getValue()

 The value to pair with the given key.
 When used for a
 :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`
 case, if value is non-empty it'll be used instead of the header value. If both are empty, no metadata is added.
 When used for a :ref:`on_header_missing <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_missing>`
 case, a non-empty value must be provided otherwise no metadata is added.
 

string value = 3 [(.udpa.annotations.field_migrate) = { ... }

Specified by:

getValue in interface Config.KeyValuePairOrBuilder

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 The value to pair with the given key.
 When used for a
 :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`
 case, if value is non-empty it'll be used instead of the header value. If both are empty, no metadata is added.
 When used for a :ref:`on_header_missing <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_missing>`
 case, a non-empty value must be provided otherwise no metadata is added.
 

string value = 3 [(.udpa.annotations.field_migrate) = { ... }

Specified by:

getValueBytes in interface Config.KeyValuePairOrBuilder

hasRegexValueRewrite

public boolean hasRegexValueRewrite()

 If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the `value` field is non-empty this field should be empty.
 

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }

Specified by:

hasRegexValueRewrite in interface Config.KeyValuePairOrBuilder

getRegexValueRewrite

public RegexMatchAndSubstitute getRegexValueRewrite()

 If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the `value` field is non-empty this field should be empty.
 

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }

Specified by:

getRegexValueRewrite in interface Config.KeyValuePairOrBuilder

getRegexValueRewriteOrBuilder

public RegexMatchAndSubstituteOrBuilder getRegexValueRewriteOrBuilder()

 If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the `value` field is non-empty this field should be empty.
 

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }

Specified by:

getRegexValueRewriteOrBuilder in interface Config.KeyValuePairOrBuilder

getTypeValue

public int getTypeValue()

 The value's type — defaults to string.
 

.envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueType type = 4 [(.validate.rules) = { ... }

Specified by:

getTypeValue in interface Config.KeyValuePairOrBuilder

getType

public Config.ValueType getType()

 The value's type — defaults to string.
 

.envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueType type = 4 [(.validate.rules) = { ... }

Specified by:

getType in interface Config.KeyValuePairOrBuilder

getEncodeValue

public int getEncodeValue()

 How is the value encoded, default is NONE (not encoded).
 The value will be decoded accordingly before storing to metadata.
 

.envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueEncode encode = 5;

Specified by:

getEncodeValue in interface Config.KeyValuePairOrBuilder

getEncode

public Config.ValueEncode getEncode()

 How is the value encoded, default is NONE (not encoded).
 The value will be decoded accordingly before storing to metadata.
 

.envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueEncode encode = 5;

Specified by:

getEncode in interface Config.KeyValuePairOrBuilder

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 Config.KeyValuePair parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.KeyValuePair parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Config.KeyValuePair parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.KeyValuePair parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.KeyValuePair parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static Config.KeyValuePair parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static Config.KeyValuePair parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public Config.KeyValuePair.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Config.KeyValuePair.Builder newBuilder()

newBuilder

public static Config.KeyValuePair.Builder newBuilder(Config.KeyValuePair prototype)

toBuilder

public Config.KeyValuePair.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Config.KeyValuePair.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Config.KeyValuePair getDefaultInstance()

parser

public static com.google.protobuf.Parser<Config.KeyValuePair> parser()

getParserForType

public com.google.protobuf.Parser<Config.KeyValuePair> 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 Config.KeyValuePair getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder