Package io.envoyproxy.envoy.config.core.v3

Class HeaderValueOption

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.HeaderValueOption
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderValueOptionOrBuilder, Serializable
@Generated public final class HeaderValueOption extends com.google.protobuf.GeneratedMessage implements HeaderValueOptionOrBuilder
 Header name/value pair plus option to control append behavior.
Protobuf type envoy.config.core.v3.HeaderValueOption
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HeaderValueOption.Builder
    Header name/value pair plus option to control append behavior.
    static enum 
    HeaderValueOption.HeaderAppendAction
    Describes the supported actions types for header append action.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private com.google.protobuf.BoolValue
    append_
     
    static final int
    APPEND_ACTION_FIELD_NUMBER
     
    static final int
    APPEND_FIELD_NUMBER
     
    private int
    appendAction_
     
    private int
    bitField0_
     
    private static final HeaderValueOption
    DEFAULT_INSTANCE
     
    private HeaderValue
    header_
     
    static final int
    HEADER_FIELD_NUMBER
     
    static final int
    KEEP_EMPTY_VALUE_FIELD_NUMBER
     
    private boolean
    keepEmptyValue_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<HeaderValueOption>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    HeaderValueOption()
     
    private
    HeaderValueOption(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.BoolValue
    getAppend()
    Deprecated.
    envoy.config.core.v3.HeaderValueOption.append is deprecated.
    HeaderValueOption.HeaderAppendAction
    getAppendAction()
    Describes the action taken to append/overwrite the given value for an existing header or to only add this header if it's absent.
    int
    getAppendActionValue()
    Describes the action taken to append/overwrite the given value for an existing header or to only add this header if it's absent.
    com.google.protobuf.BoolValueOrBuilder
    getAppendOrBuilder()
    Deprecated.
    static HeaderValueOption
    getDefaultInstance()
     
    HeaderValueOption
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    HeaderValue
    getHeader()
    Header name/value pair that this option applies to.
    HeaderValueOrBuilder
    getHeaderOrBuilder()
    Header name/value pair that this option applies to.
    boolean
    getKeepEmptyValue()
    Is the header value allowed to be empty? If false (default), custom headers with empty values are dropped, otherwise they are added.
    com.google.protobuf.Parser<HeaderValueOption>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasAppend()
    Deprecated.
    envoy.config.core.v3.HeaderValueOption.append is deprecated.
    int
    hashCode()
     
    boolean
    hasHeader()
    Header name/value pair that this option applies to.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static HeaderValueOption.Builder
    newBuilder()
     
    static HeaderValueOption.Builder
    newBuilder(HeaderValueOption prototype)
     
    HeaderValueOption.Builder
    newBuilderForType()
     
    protected HeaderValueOption.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static HeaderValueOption
    parseDelimitedFrom(InputStream input)
     
    static HeaderValueOption
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderValueOption
    parseFrom(byte[] data)
     
    static HeaderValueOption
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderValueOption
    parseFrom(com.google.protobuf.ByteString data)
     
    static HeaderValueOption
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderValueOption
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HeaderValueOption
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderValueOption
    parseFrom(InputStream input)
     
    static HeaderValueOption
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderValueOption
    parseFrom(ByteBuffer data)
     
    static HeaderValueOption
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HeaderValueOption>
    parser()
     
    HeaderValueOption.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • HEADER_FIELD_NUMBER

      public static final int HEADER_FIELD_NUMBER
      See Also:

    • header_

      private HeaderValue header_

    • APPEND_FIELD_NUMBER

      public static final int APPEND_FIELD_NUMBER
      See Also:

    • append_

      private com.google.protobuf.BoolValue append_

    • APPEND_ACTION_FIELD_NUMBER

      public static final int APPEND_ACTION_FIELD_NUMBER
      See Also:

    • appendAction_

      private int appendAction_

    • KEEP_EMPTY_VALUE_FIELD_NUMBER

      public static final int KEEP_EMPTY_VALUE_FIELD_NUMBER
      See Also:

    • keepEmptyValue_

      private boolean keepEmptyValue_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final HeaderValueOption DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<HeaderValueOption> PARSER

  • Constructor Details

    • HeaderValueOption

      private HeaderValueOption(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • HeaderValueOption

      private HeaderValueOption()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasHeader

      public boolean hasHeader()
       Header name/value pair that this option applies to.
      .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }
      Specified by:
      hasHeader in interface HeaderValueOptionOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public HeaderValue getHeader()
       Header name/value pair that this option applies to.
      .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface HeaderValueOptionOrBuilder
      Returns:
      The header.

    • getHeaderOrBuilder

      public HeaderValueOrBuilder getHeaderOrBuilder()
       Header name/value pair that this option applies to.
      .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeaderOrBuilder in interface HeaderValueOptionOrBuilder

    • hasAppend

      @Deprecated public boolean hasAppend()
      Deprecated.
      envoy.config.core.v3.HeaderValueOption.append is deprecated. See envoy/config/core/v3/base.proto;l=437
       Should the value be appended? If true (default), the value is appended to
 existing values. Otherwise it replaces any existing values.
 This field is deprecated and please use
 :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.

 .. note::
 The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
 :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
 default value (``false``) for this field.
      .google.protobuf.BoolValue append = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasAppend in interface HeaderValueOptionOrBuilder
      Returns:
      Whether the append field is set.

    • getAppend

      @Deprecated public com.google.protobuf.BoolValue getAppend()
      Deprecated.
      envoy.config.core.v3.HeaderValueOption.append is deprecated. See envoy/config/core/v3/base.proto;l=437
       Should the value be appended? If true (default), the value is appended to
 existing values. Otherwise it replaces any existing values.
 This field is deprecated and please use
 :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.

 .. note::
 The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
 :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
 default value (``false``) for this field.
      .google.protobuf.BoolValue append = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getAppend in interface HeaderValueOptionOrBuilder
      Returns:
      The append.

    • getAppendOrBuilder

      @Deprecated public com.google.protobuf.BoolValueOrBuilder getAppendOrBuilder()
      Deprecated.
       Should the value be appended? If true (default), the value is appended to
 existing values. Otherwise it replaces any existing values.
 This field is deprecated and please use
 :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.

 .. note::
 The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
 :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
 default value (``false``) for this field.
      .google.protobuf.BoolValue append = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getAppendOrBuilder in interface HeaderValueOptionOrBuilder

    • getAppendActionValue

      public int getAppendActionValue()
       Describes the action taken to append/overwrite the given value for an existing header
 or to only add this header if it's absent.
 Value defaults to :ref:`APPEND_IF_EXISTS_OR_ADD
 <envoy_v3_api_enum_value_config.core.v3.HeaderValueOption.HeaderAppendAction.APPEND_IF_EXISTS_OR_ADD>`.
      .envoy.config.core.v3.HeaderValueOption.HeaderAppendAction append_action = 3 [(.validate.rules) = { ... }
      Specified by:
      getAppendActionValue in interface HeaderValueOptionOrBuilder
      Returns:
      The enum numeric value on the wire for appendAction.

    • getAppendAction

      public HeaderValueOption.HeaderAppendAction getAppendAction()
       Describes the action taken to append/overwrite the given value for an existing header
 or to only add this header if it's absent.
 Value defaults to :ref:`APPEND_IF_EXISTS_OR_ADD
 <envoy_v3_api_enum_value_config.core.v3.HeaderValueOption.HeaderAppendAction.APPEND_IF_EXISTS_OR_ADD>`.
      .envoy.config.core.v3.HeaderValueOption.HeaderAppendAction append_action = 3 [(.validate.rules) = { ... }
      Specified by:
      getAppendAction in interface HeaderValueOptionOrBuilder
      Returns:
      The appendAction.

    • getKeepEmptyValue

      public boolean getKeepEmptyValue()
       Is the header value allowed to be empty? If false (default), custom headers with empty values are dropped,
 otherwise they are added.
      bool keep_empty_value = 4;
      Specified by:
      getKeepEmptyValue in interface HeaderValueOptionOrBuilder
      Returns:
      The keepEmptyValue.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 HeaderValueOption parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static HeaderValueOption parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static HeaderValueOption parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static HeaderValueOption parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static HeaderValueOption parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static HeaderValueOption parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public HeaderValueOption.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HeaderValueOption.Builder newBuilder()

    • newBuilder

      public static HeaderValueOption.Builder newBuilder(HeaderValueOption prototype)

    • toBuilder

      public HeaderValueOption.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HeaderValueOption.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HeaderValueOption getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<HeaderValueOption> 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.GeneratedMessage

    • getDefaultInstanceForType

      public HeaderValueOption getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder