ProxyProtocol.Rule.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Rule.Builder>
    - - io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule.Builder

All Implemented Interfaces:

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

Enclosing class:

ProxyProtocol.Rule
```
public static final class ProxyProtocol.Rule.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Rule.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProxyProtocol.Rule.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ProxyProtocol.Rule`	`build()`
`ProxyProtocol.Rule`	`buildPartial()`
`ProxyProtocol.Rule.Builder`	`clear()`
`ProxyProtocol.Rule.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ProxyProtocol.Rule.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ProxyProtocol.Rule.Builder`	`clearOnTlvPresent()` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.Rule.Builder`	`clearTlvType()` The type that triggers the rule - required TLV type is defined as uint8_t in proxy protocol.
`ProxyProtocol.Rule.Builder`	`clone()`
`ProxyProtocol.Rule`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`ProxyProtocol.KeyValuePair`	`getOnTlvPresent()` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.KeyValuePair.Builder`	`getOnTlvPresentBuilder()` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.KeyValuePairOrBuilder`	`getOnTlvPresentOrBuilder()` If the TLV type is present, apply this metadata KeyValuePair.
`int`	`getTlvType()` The type that triggers the rule - required TLV type is defined as uint8_t in proxy protocol.
`boolean`	`hasOnTlvPresent()` If the TLV type is present, apply this metadata KeyValuePair.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ProxyProtocol.Rule.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ProxyProtocol.Rule.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ProxyProtocol.Rule.Builder`	`mergeFrom(ProxyProtocol.Rule other)`
`ProxyProtocol.Rule.Builder`	`mergeOnTlvPresent(ProxyProtocol.KeyValuePair value)` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.Rule.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ProxyProtocol.Rule.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ProxyProtocol.Rule.Builder`	`setOnTlvPresent(ProxyProtocol.KeyValuePair.Builder builderForValue)` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.Rule.Builder`	`setOnTlvPresent(ProxyProtocol.KeyValuePair value)` If the TLV type is present, apply this metadata KeyValuePair.
`ProxyProtocol.Rule.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ProxyProtocol.Rule.Builder`	`setTlvType(int value)` The type that triggers the rule - required TLV type is defined as uint8_t in proxy protocol.
`ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - clear
```
public ProxyProtocol.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<ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - getDefaultInstanceForType
```
public ProxyProtocol.Rule getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ProxyProtocol.Rule build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ProxyProtocol.Rule buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - setField
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - clearField
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - clearOneof
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - setRepeatedField
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - addRepeatedField
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - mergeFrom
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - mergeFrom
```
public ProxyProtocol.Rule.Builder mergeFrom(ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - mergeFrom
```
public ProxyProtocol.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<ProxyProtocol.Rule.Builder>
    
    Throws:
    
    IOException
  - 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
  - setTlvType
```
public ProxyProtocol.Rule.Builder setTlvType(int value)
```
```
 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) = { ... }
  - clearTlvType
```
public ProxyProtocol.Rule.Builder clearTlvType()
```
```
 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) = { ... }
  - 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
  - setOnTlvPresent
```
public ProxyProtocol.Rule.Builder setOnTlvPresent(ProxyProtocol.KeyValuePair value)
```
```
 If the TLV type is present, apply this metadata KeyValuePair.
 
```
    .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;
  - setOnTlvPresent
```
public ProxyProtocol.Rule.Builder setOnTlvPresent(ProxyProtocol.KeyValuePair.Builder builderForValue)
```
```
 If the TLV type is present, apply this metadata KeyValuePair.
 
```
    .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;
  - mergeOnTlvPresent
```
public ProxyProtocol.Rule.Builder mergeOnTlvPresent(ProxyProtocol.KeyValuePair value)
```
```
 If the TLV type is present, apply this metadata KeyValuePair.
 
```
    .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;
  - clearOnTlvPresent
```
public ProxyProtocol.Rule.Builder clearOnTlvPresent()
```
```
 If the TLV type is present, apply this metadata KeyValuePair.
 
```
    .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;
  - getOnTlvPresentBuilder
```
public ProxyProtocol.KeyValuePair.Builder getOnTlvPresentBuilder()
```
```
 If the TLV type is present, apply this metadata KeyValuePair.
 
```
    .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.KeyValuePair on_tlv_present = 2;
  - 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
  - setUnknownFields
```
public final ProxyProtocol.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<ProxyProtocol.Rule.Builder>
  - mergeUnknownFields
```
public final ProxyProtocol.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<ProxyProtocol.Rule.Builder>

Class ProxyProtocol.Rule.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getTlvType

setTlvType

clearTlvType

hasOnTlvPresent

getOnTlvPresent

setOnTlvPresent

setOnTlvPresent

mergeOnTlvPresent

clearOnTlvPresent

getOnTlvPresentBuilder

getOnTlvPresentOrBuilder

setUnknownFields

mergeUnknownFields