io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3

Class ProxyProtocol.Rule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule

All Implemented Interfaces:

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

Enclosing class:

ProxyProtocol

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

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

Protobuf type envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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	ON_TLV_PRESENT_FIELD_NUMBER
static int	TLV_TYPE_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 ProxyProtocol.Rule	getDefaultInstance()
ProxyProtocol.Rule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ProxyProtocol.KeyValuePair	getOnTlvPresent() If the TLV type is present, apply this metadata KeyValuePair.
ProxyProtocol.KeyValuePairOrBuilder	getOnTlvPresentOrBuilder() If the TLV type is present, apply this metadata KeyValuePair.
com.google.protobuf.Parser<ProxyProtocol.Rule>	getParserForType()
int	getSerializedSize()
int	getTlvType() The type that triggers the rule - required TLV type is defined as uint8_t in proxy protocol.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasOnTlvPresent() If the TLV type is present, apply this metadata KeyValuePair.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ProxyProtocol.Rule.Builder	newBuilder()
static ProxyProtocol.Rule.Builder	newBuilder(ProxyProtocol.Rule prototype)
ProxyProtocol.Rule.Builder	newBuilderForType()
protected ProxyProtocol.Rule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ProxyProtocol.Rule	parseDelimitedFrom(InputStream input)
static ProxyProtocol.Rule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProxyProtocol.Rule	parseFrom(byte[] data)
static ProxyProtocol.Rule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProxyProtocol.Rule	parseFrom(ByteBuffer data)
static ProxyProtocol.Rule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProxyProtocol.Rule	parseFrom(com.google.protobuf.ByteString data)
static ProxyProtocol.Rule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProxyProtocol.Rule	parseFrom(com.google.protobuf.CodedInputStream input)
static ProxyProtocol.Rule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProxyProtocol.Rule	parseFrom(InputStream input)
static ProxyProtocol.Rule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ProxyProtocol.Rule>	parser()
ProxyProtocol.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

TLV_TYPE_FIELD_NUMBER

public static final int TLV_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

ON_TLV_PRESENT_FIELD_NUMBER

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

getTlvType

public int getTlvType()

 The type that triggers the rule - required
 TLV type is defined as uint8_t in proxy protocol. See `the spec
 <https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt>`_ for details.
 

uint32 tlv_type = 1 [(.validate.rules) = { ... }

Specified by:

getTlvType in interface ProxyProtocol.RuleOrBuilder

hasOnTlvPresent

public boolean hasOnTlvPresent()

 If the TLV type is present, apply this metadata KeyValuePair.
 

.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;

Specified by:

hasOnTlvPresent in interface ProxyProtocol.RuleOrBuilder

getOnTlvPresent

public ProxyProtocol.KeyValuePair getOnTlvPresent()

 If the TLV type is present, apply this metadata KeyValuePair.
 

.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;

Specified by:

getOnTlvPresent in interface ProxyProtocol.RuleOrBuilder

getOnTlvPresentOrBuilder

public ProxyProtocol.KeyValuePairOrBuilder getOnTlvPresentOrBuilder()

 If the TLV type is present, apply this metadata KeyValuePair.
 

.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;

Specified by:

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ProxyProtocol.Rule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ProxyProtocol.Rule.Builder newBuilder()

newBuilder

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

toBuilder

public ProxyProtocol.Rule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ProxyProtocol.Rule getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder