Package io.envoyproxy.envoy.extensions.http.original_ip_detection.custom_header.v3

Class CustomHeaderConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.http.original_ip_detection.custom_header.v3.CustomHeaderConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CustomHeaderConfigOrBuilder, Serializable

public final class CustomHeaderConfig
extends com.google.protobuf.GeneratedMessageV3
implements CustomHeaderConfigOrBuilder

 This extension allows for the original downstream remote IP to be detected
 by reading the value from a configured header name. If the value is successfully parsed
 as an IP, it'll be treated as the effective downstream remote address and seen as such
 by all filters. See :ref:`original_ip_detection_extensions
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.original_ip_detection_extensions>`
 for an overview of how extensions operate and what happens when an extension fails
 to detect the remote IP.

 [#extension: envoy.http.original_ip_detection.custom_header]
 

Protobuf type envoy.extensions.http.original_ip_detection.custom_header.v3.CustomHeaderConfig

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CustomHeaderConfig.Builder	This extension allows for the original downstream remote IP to be detected by reading the value from a configured header name.

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	ALLOW_EXTENSION_TO_SET_ADDRESS_AS_TRUSTED_FIELD_NUMBER
static final int	HEADER_NAME_FIELD_NUMBER
static final int	REJECT_WITH_STATUS_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)
boolean	getAllowExtensionToSetAddressAsTrusted()	If set to true, the extension could decide that the detected address should be treated as trusted by the HCM.
static CustomHeaderConfig	getDefaultInstance()
CustomHeaderConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getHeaderName()	The header name containing the original downstream remote address, if present.
com.google.protobuf.ByteString	getHeaderNameBytes()	The header name containing the original downstream remote address, if present.
com.google.protobuf.Parser<CustomHeaderConfig>	getParserForType()
HttpStatus	getRejectWithStatus()	If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.
HttpStatusOrBuilder	getRejectWithStatusOrBuilder()	If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.
int	getSerializedSize()
int	hashCode()
boolean	hasRejectWithStatus()	If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static CustomHeaderConfig.Builder	newBuilder()
static CustomHeaderConfig.Builder	newBuilder(CustomHeaderConfig prototype)
CustomHeaderConfig.Builder	newBuilderForType()
protected CustomHeaderConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomHeaderConfig	parseDelimitedFrom(InputStream input)
static CustomHeaderConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomHeaderConfig	parseFrom(byte[] data)
static CustomHeaderConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomHeaderConfig	parseFrom(com.google.protobuf.ByteString data)
static CustomHeaderConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomHeaderConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static CustomHeaderConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomHeaderConfig	parseFrom(InputStream input)
static CustomHeaderConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomHeaderConfig	parseFrom(ByteBuffer data)
static CustomHeaderConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomHeaderConfig>	parser()
CustomHeaderConfig.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

HEADER_NAME_FIELD_NUMBER

public static final int HEADER_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

ALLOW_EXTENSION_TO_SET_ADDRESS_AS_TRUSTED_FIELD_NUMBER

public static final int ALLOW_EXTENSION_TO_SET_ADDRESS_AS_TRUSTED_FIELD_NUMBER

See Also:

• Constant Field Values

REJECT_WITH_STATUS_FIELD_NUMBER

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

getHeaderName

public String getHeaderName()

 The header name containing the original downstream remote address, if present.

 Note: in the case of a multi-valued header, only the first value is tried and the rest are ignored.
 

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

Specified by:

getHeaderName in interface CustomHeaderConfigOrBuilder

Returns:

The headerName.

getHeaderNameBytes

public com.google.protobuf.ByteString getHeaderNameBytes()

 The header name containing the original downstream remote address, if present.

 Note: in the case of a multi-valued header, only the first value is tried and the rest are ignored.
 

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

Specified by:

getHeaderNameBytes in interface CustomHeaderConfigOrBuilder

Returns:

The bytes for headerName.

getAllowExtensionToSetAddressAsTrusted

public boolean getAllowExtensionToSetAddressAsTrusted()

 If set to true, the extension could decide that the detected address should be treated as
 trusted by the HCM. If the address is considered :ref:`trusted<config_http_conn_man_headers_x-forwarded-for_trusted_client_address>`,
 it might be used as input to determine if the request is internal (among other things).
 

bool allow_extension_to_set_address_as_trusted = 2;

Specified by:

getAllowExtensionToSetAddressAsTrusted in interface CustomHeaderConfigOrBuilder

Returns:

The allowExtensionToSetAddressAsTrusted.

hasRejectWithStatus

public boolean hasRejectWithStatus()

 If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
 

.envoy.type.v3.HttpStatus reject_with_status = 3;

Specified by:

hasRejectWithStatus in interface CustomHeaderConfigOrBuilder

Returns:

Whether the rejectWithStatus field is set.

getRejectWithStatus

public HttpStatus getRejectWithStatus()

 If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
 

.envoy.type.v3.HttpStatus reject_with_status = 3;

Specified by:

getRejectWithStatus in interface CustomHeaderConfigOrBuilder

Returns:

The rejectWithStatus.

getRejectWithStatusOrBuilder

public HttpStatusOrBuilder getRejectWithStatusOrBuilder()

 If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
 

.envoy.type.v3.HttpStatus reject_with_status = 3;

Specified by:

getRejectWithStatusOrBuilder in interface CustomHeaderConfigOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomHeaderConfig parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CustomHeaderConfig parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CustomHeaderConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CustomHeaderConfig.Builder newBuilder()

newBuilder

public static CustomHeaderConfig.Builder newBuilder(CustomHeaderConfig prototype)

toBuilder

public CustomHeaderConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CustomHeaderConfig getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder