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

Class HeaderValueOption.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderValueOptionOrBuilder, java.lang.Cloneable
    Enclosing class:
    HeaderValueOption
    public static final class HeaderValueOption.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HeaderValueOption.Builder>
implements HeaderValueOptionOrBuilder
     Header name/value pair plus option to control append behavior.
    Protobuf type envoy.config.core.v3.HeaderValueOption

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

      • clear

        public HeaderValueOption.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<HeaderValueOption.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<HeaderValueOption.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public HeaderValueOption.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<HeaderValueOption.Builder>

      • setField

        public HeaderValueOption.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValueOption.Builder>

      • clearField

        public HeaderValueOption.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<HeaderValueOption.Builder>

      • clearOneof

        public HeaderValueOption.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<HeaderValueOption.Builder>

      • setRepeatedField

        public HeaderValueOption.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValueOption.Builder>

      • addRepeatedField

        public HeaderValueOption.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValueOption.Builder>

      • mergeFrom

        public HeaderValueOption.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<HeaderValueOption.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValueOption.Builder>

      • mergeFrom

        public HeaderValueOption.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.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<HeaderValueOption.Builder>
        Throws:
        java.io.IOException

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

      • setHeader

        public HeaderValueOption.Builder setHeader​(HeaderValue value)
         Header name/value pair that this option applies to.
        .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }

      • setHeader

        public HeaderValueOption.Builder setHeader​(HeaderValue.Builder builderForValue)
         Header name/value pair that this option applies to.
        .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }

      • mergeHeader

        public HeaderValueOption.Builder mergeHeader​(HeaderValue value)
         Header name/value pair that this option applies to.
        .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }

      • clearHeader

        public HeaderValueOption.Builder clearHeader()
         Header name/value pair that this option applies to.
        .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }

      • getHeaderBuilder

        public HeaderValue.Builder getHeaderBuilder()
         Header name/value pair that this option applies to.
        .envoy.config.core.v3.HeaderValue header = 1 [(.validate.rules) = { ... }

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

      • setAppend

        @Deprecated
public HeaderValueOption.Builder setAppend​(com.google.protobuf.BoolValue value)
        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"];

      • setAppend

        @Deprecated
public HeaderValueOption.Builder setAppend​(com.google.protobuf.BoolValue.Builder builderForValue)
        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"];

      • mergeAppend

        @Deprecated
public HeaderValueOption.Builder mergeAppend​(com.google.protobuf.BoolValue value)
        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"];

      • clearAppend

        @Deprecated
public HeaderValueOption.Builder clearAppend()
        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"];

      • getAppendBuilder

        @Deprecated
public com.google.protobuf.BoolValue.Builder getAppendBuilder()
        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"];

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

      • setAppendActionValue

        public HeaderValueOption.Builder setAppendActionValue​(int value)
         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) = { ... }
        Parameters:
        value - The enum numeric value on the wire for appendAction to set.
        Returns:
        This builder for chaining.

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

      • setAppendAction

        public HeaderValueOption.Builder setAppendAction​(HeaderValueOption.HeaderAppendAction value)
         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) = { ... }
        Parameters:
        value - The appendAction to set.
        Returns:
        This builder for chaining.

      • clearAppendAction

        public HeaderValueOption.Builder clearAppendAction()
         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) = { ... }
        Returns:
        This builder for chaining.

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

      • setKeepEmptyValue

        public HeaderValueOption.Builder setKeepEmptyValue​(boolean value)
         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;
        Parameters:
        value - The keepEmptyValue to set.
        Returns:
        This builder for chaining.

      • clearKeepEmptyValue

        public HeaderValueOption.Builder clearKeepEmptyValue()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final HeaderValueOption.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<HeaderValueOption.Builder>

      • mergeUnknownFields

        public final HeaderValueOption.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<HeaderValueOption.Builder>