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

Class HeaderValueOption

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderValueOptionOrBuilder, Serializable
    public final class HeaderValueOption
extends com.google.protobuf.GeneratedMessageV3
implements HeaderValueOptionOrBuilder
     Header name/value pair plus option to control append behavior.
    Protobuf type envoy.config.core.v3.HeaderValueOption
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • 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

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

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

      • hasAppend

        @Deprecated
public boolean hasAppend()
        Deprecated.
        envoy.config.core.v3.HeaderValueOption.append is deprecated. See envoy/config/core/v3/base.proto;l=365
         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=365
         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.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 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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