io.envoyproxy.envoy.config.filter.http.header_to_metadata.v2

Class Config.Rule.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

io.envoyproxy.envoy.config.filter.http.header_to_metadata.v2.Config.Rule.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RuleOrBuilder, Cloneable

Enclosing class:

Config.Rule

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

 A Rule defines what metadata to apply when a header is present or missing.
 

Protobuf type envoy.config.filter.http.header_to_metadata.v2.Config.Rule

Method Summary

Modifier and Type	Method and Description
Config.Rule.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Config.Rule	build()
Config.Rule	buildPartial()
Config.Rule.Builder	clear()
Config.Rule.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Config.Rule.Builder	clearHeader() The header that triggers this rule — required.
Config.Rule.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Config.Rule.Builder	clearOnHeaderMissing() If the header is not present, apply this metadata KeyValuePair.
Config.Rule.Builder	clearOnHeaderPresent() If the header is present, apply this metadata KeyValuePair.
Config.Rule.Builder	clearRemove() Whether or not to remove the header after a rule is applied.
Config.Rule.Builder	clone()
Config.Rule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getHeader() The header that triggers this rule — required.
com.google.protobuf.ByteString	getHeaderBytes() The header that triggers this rule — required.
Config.KeyValuePair	getOnHeaderMissing() If the header is not present, apply this metadata KeyValuePair.
Config.KeyValuePair.Builder	getOnHeaderMissingBuilder() If the header is not present, apply this metadata KeyValuePair.
Config.KeyValuePairOrBuilder	getOnHeaderMissingOrBuilder() If the header is not present, apply this metadata KeyValuePair.
Config.KeyValuePair	getOnHeaderPresent() If the header is present, apply this metadata KeyValuePair.
Config.KeyValuePair.Builder	getOnHeaderPresentBuilder() If the header is present, apply this metadata KeyValuePair.
Config.KeyValuePairOrBuilder	getOnHeaderPresentOrBuilder() If the header is present, apply this metadata KeyValuePair.
boolean	getRemove() Whether or not to remove the header after a rule is applied.
boolean	hasOnHeaderMissing() If the header is not present, apply this metadata KeyValuePair.
boolean	hasOnHeaderPresent() If the header is present, apply this metadata KeyValuePair.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Config.Rule.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Config.Rule.Builder	mergeFrom(Config.Rule other)
Config.Rule.Builder	mergeFrom(com.google.protobuf.Message other)
Config.Rule.Builder	mergeOnHeaderMissing(Config.KeyValuePair value) If the header is not present, apply this metadata KeyValuePair.
Config.Rule.Builder	mergeOnHeaderPresent(Config.KeyValuePair value) If the header is present, apply this metadata KeyValuePair.
Config.Rule.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Config.Rule.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Config.Rule.Builder	setHeader(String value) The header that triggers this rule — required.
Config.Rule.Builder	setHeaderBytes(com.google.protobuf.ByteString value) The header that triggers this rule — required.
Config.Rule.Builder	setOnHeaderMissing(Config.KeyValuePair.Builder builderForValue) If the header is not present, apply this metadata KeyValuePair.
Config.Rule.Builder	setOnHeaderMissing(Config.KeyValuePair value) If the header is not present, apply this metadata KeyValuePair.
Config.Rule.Builder	setOnHeaderPresent(Config.KeyValuePair.Builder builderForValue) If the header is present, apply this metadata KeyValuePair.
Config.Rule.Builder	setOnHeaderPresent(Config.KeyValuePair value) If the header is present, apply this metadata KeyValuePair.
Config.Rule.Builder	setRemove(boolean value) Whether or not to remove the header after a rule is applied.
Config.Rule.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Config.Rule.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Config.Rule.Builder>

clear

public Config.Rule.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

getDefaultInstanceForType

public Config.Rule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Config.Rule build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Config.Rule buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Config.Rule.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

setField

public Config.Rule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

clearField

public Config.Rule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

clearOneof

public Config.Rule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

setRepeatedField

public Config.Rule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

addRepeatedField

public Config.Rule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

mergeFrom

public Config.Rule.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.Rule.Builder>

mergeFrom

public Config.Rule.Builder mergeFrom(Config.Rule other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Config.Rule.Builder>

Throws:

IOException

getHeader

public String getHeader()

 The header that triggers this rule — required.
 

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

Specified by:

getHeader in interface Config.RuleOrBuilder

getHeaderBytes

public com.google.protobuf.ByteString getHeaderBytes()

 The header that triggers this rule — required.
 

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

Specified by:

getHeaderBytes in interface Config.RuleOrBuilder

setHeader

public Config.Rule.Builder setHeader(String value)

 The header that triggers this rule — required.
 

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

clearHeader

public Config.Rule.Builder clearHeader()

 The header that triggers this rule — required.
 

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

setHeaderBytes

public Config.Rule.Builder setHeaderBytes(com.google.protobuf.ByteString value)

 The header that triggers this rule — required.
 

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

hasOnHeaderPresent

public boolean hasOnHeaderPresent()

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

Specified by:

hasOnHeaderPresent in interface Config.RuleOrBuilder

getOnHeaderPresent

public Config.KeyValuePair getOnHeaderPresent()

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

Specified by:

getOnHeaderPresent in interface Config.RuleOrBuilder

setOnHeaderPresent

public Config.Rule.Builder setOnHeaderPresent(Config.KeyValuePair value)

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

setOnHeaderPresent

public Config.Rule.Builder setOnHeaderPresent(Config.KeyValuePair.Builder builderForValue)

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

mergeOnHeaderPresent

public Config.Rule.Builder mergeOnHeaderPresent(Config.KeyValuePair value)

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

clearOnHeaderPresent

public Config.Rule.Builder clearOnHeaderPresent()

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

getOnHeaderPresentBuilder

public Config.KeyValuePair.Builder getOnHeaderPresentBuilder()

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

getOnHeaderPresentOrBuilder

public Config.KeyValuePairOrBuilder getOnHeaderPresentOrBuilder()

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

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;

Specified by:

getOnHeaderPresentOrBuilder in interface Config.RuleOrBuilder

hasOnHeaderMissing

public boolean hasOnHeaderMissing()

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

Specified by:

hasOnHeaderMissing in interface Config.RuleOrBuilder

getOnHeaderMissing

public Config.KeyValuePair getOnHeaderMissing()

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

Specified by:

getOnHeaderMissing in interface Config.RuleOrBuilder

setOnHeaderMissing

public Config.Rule.Builder setOnHeaderMissing(Config.KeyValuePair value)

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

setOnHeaderMissing

public Config.Rule.Builder setOnHeaderMissing(Config.KeyValuePair.Builder builderForValue)

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

mergeOnHeaderMissing

public Config.Rule.Builder mergeOnHeaderMissing(Config.KeyValuePair value)

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

clearOnHeaderMissing

public Config.Rule.Builder clearOnHeaderMissing()

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

getOnHeaderMissingBuilder

public Config.KeyValuePair.Builder getOnHeaderMissingBuilder()

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

getOnHeaderMissingOrBuilder

public Config.KeyValuePairOrBuilder getOnHeaderMissingOrBuilder()

 If the header 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 value.
 

.envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;

Specified by:

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

bool remove = 4;

Specified by:

getRemove in interface Config.RuleOrBuilder

setRemove

public Config.Rule.Builder setRemove(boolean value)

 Whether or not to remove the header after a rule is applied.
 This prevents headers from leaking.
 

bool remove = 4;

clearRemove

public Config.Rule.Builder clearRemove()

 Whether or not to remove the header after a rule is applied.
 This prevents headers from leaking.
 

bool remove = 4;

setUnknownFields

public final Config.Rule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>

mergeUnknownFields

public final Config.Rule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>