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

Class Config.Rule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.Rule

All Implemented Interfaces:

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

Enclosing class:

Config

public static final class Config.Rule
extends com.google.protobuf.GeneratedMessageV3
implements Config.RuleOrBuilder

 A Rule defines what metadata to apply when a header is present or missing.
 [#next-free-field: 6]
 

Protobuf type envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.Rule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.Rule.Builder A Rule defines what metadata to apply when a header is present or missing.
static class	Config.Rule.HeaderCookieSpecifierCase

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	COOKIE_FIELD_NUMBER
static int	HEADER_FIELD_NUMBER
static int	ON_MISSING_FIELD_NUMBER
static int	ON_PRESENT_FIELD_NUMBER
static int	REMOVE_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)
String	getCookie() The cookie to be extracted.
com.google.protobuf.ByteString	getCookieBytes() The cookie to be extracted.
static Config.Rule	getDefaultInstance()
Config.Rule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getHeader() Specifies that a match will be performed on the value of a header or a cookie.
com.google.protobuf.ByteString	getHeaderBytes() Specifies that a match will be performed on the value of a header or a cookie.
Config.Rule.HeaderCookieSpecifierCase	getHeaderCookieSpecifierCase()
Config.KeyValuePair	getOnMissing() If the header or cookie is not present, apply this metadata KeyValuePair.
Config.KeyValuePairOrBuilder	getOnMissingOrBuilder() If the header or cookie is not present, apply this metadata KeyValuePair.
Config.KeyValuePair	getOnPresent() If the header or cookie is present, apply this metadata KeyValuePair.
Config.KeyValuePairOrBuilder	getOnPresentOrBuilder() If the header or cookie is present, apply this metadata KeyValuePair.
com.google.protobuf.Parser<Config.Rule>	getParserForType()
boolean	getRemove() Whether or not to remove the header after a rule is applied.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasOnMissing() If the header or cookie is not present, apply this metadata KeyValuePair.
boolean	hasOnPresent() If the header or cookie is present, apply this metadata KeyValuePair.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Config.Rule.Builder	newBuilder()
static Config.Rule.Builder	newBuilder(Config.Rule prototype)
Config.Rule.Builder	newBuilderForType()
protected Config.Rule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Config.Rule	parseDelimitedFrom(InputStream input)
static Config.Rule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.Rule	parseFrom(byte[] data)
static Config.Rule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.Rule	parseFrom(ByteBuffer data)
static Config.Rule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.Rule	parseFrom(com.google.protobuf.ByteString data)
static Config.Rule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.Rule	parseFrom(com.google.protobuf.CodedInputStream input)
static Config.Rule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.Rule	parseFrom(InputStream input)
static Config.Rule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Config.Rule>	parser()
Config.Rule.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

HEADER_FIELD_NUMBER

public static final int HEADER_FIELD_NUMBER

See Also:

Constant Field Values

COOKIE_FIELD_NUMBER

public static final int COOKIE_FIELD_NUMBER

See Also:

Constant Field Values

ON_PRESENT_FIELD_NUMBER

public static final int ON_PRESENT_FIELD_NUMBER

See Also:

Constant Field Values

ON_MISSING_FIELD_NUMBER

public static final int ON_MISSING_FIELD_NUMBER

See Also:

Constant Field Values

REMOVE_FIELD_NUMBER

public static final int REMOVE_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

getHeaderCookieSpecifierCase

public Config.Rule.HeaderCookieSpecifierCase getHeaderCookieSpecifierCase()

Specified by:

getHeaderCookieSpecifierCase in interface Config.RuleOrBuilder

getHeader

public String getHeader()

 Specifies that a match will be performed on the value of a header or a cookie.
 The header to be extracted.
 

string header = 1 [(.validate.rules) = { ... }

Specified by:

getHeader in interface Config.RuleOrBuilder

getHeaderBytes

public com.google.protobuf.ByteString getHeaderBytes()

 Specifies that a match will be performed on the value of a header or a cookie.
 The header to be extracted.
 

string header = 1 [(.validate.rules) = { ... }

Specified by:

getHeaderBytes in interface Config.RuleOrBuilder

getCookie

public String getCookie()

 The cookie to be extracted.
 

string cookie = 5 [(.validate.rules) = { ... }

Specified by:

getCookie in interface Config.RuleOrBuilder

getCookieBytes

public com.google.protobuf.ByteString getCookieBytes()

 The cookie to be extracted.
 

string cookie = 5 [(.validate.rules) = { ... }

Specified by:

getCookieBytes in interface Config.RuleOrBuilder

hasOnPresent

public boolean hasOnPresent()

 If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_present = 2;

Specified by:

hasOnPresent in interface Config.RuleOrBuilder

getOnPresent

public Config.KeyValuePair getOnPresent()

 If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_present = 2;

Specified by:

getOnPresent in interface Config.RuleOrBuilder

getOnPresentOrBuilder

public Config.KeyValuePairOrBuilder getOnPresentOrBuilder()

 If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_present = 2;

Specified by:

getOnPresentOrBuilder in interface Config.RuleOrBuilder

hasOnMissing

public boolean hasOnMissing()

 If the header or cookie is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_missing = 3;

Specified by:

hasOnMissing in interface Config.RuleOrBuilder

getOnMissing

public Config.KeyValuePair getOnMissing()

 If the header or cookie is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_missing = 3;

Specified by:

getOnMissing in interface Config.RuleOrBuilder

getOnMissingOrBuilder

public Config.KeyValuePairOrBuilder getOnMissingOrBuilder()

 If the header or cookie is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header or cookie value.
 

.envoy.extensions.filters.http.header_to_metadata.v4alpha.Config.KeyValuePair on_missing = 3;

Specified by:

getOnMissingOrBuilder in interface Config.RuleOrBuilder

getRemove

public boolean getRemove()

 Whether or not to remove the header after a rule is applied.
 This prevents headers from leaking.
 This field is not supported in case of a cookie.
 

bool remove = 4;

Specified by:

getRemove in interface Config.RuleOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.Rule 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.Rule parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Config.Rule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Config.Rule.Builder newBuilder()

newBuilder

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

toBuilder

public Config.Rule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Config.Rule getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder