Package io.envoyproxy.envoy.extensions.filters.http.header_to_metadata.v3

Class Config.Rule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder>
io.envoyproxy.envoy.extensions.filters.http.header_to_metadata.v3.Config.Rule.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RuleOrBuilder, Cloneable
Enclosing class:
Config.Rule
public static final class Config.Rule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Config.Rule.Builder> implements Config.RuleOrBuilder
 A Rule defines what metadata to apply when a header is present or missing.
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.header_to_metadata.v3.Config.Rule

  • Method Details

    • 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<Config.Rule.Builder>

    • clear

      public Config.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<Config.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<Config.Rule.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Config.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<Config.Rule.Builder>

    • setField

      public Config.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<Config.Rule.Builder>

    • clearField

      public Config.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<Config.Rule.Builder>

    • clearOneof

      public Config.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<Config.Rule.Builder>

    • setRepeatedField

      public Config.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<Config.Rule.Builder>

    • addRepeatedField

      public Config.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<Config.Rule.Builder>

    • mergeFrom

      public Config.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<Config.Rule.Builder>

    • mergeFrom

      public Config.Rule.Builder mergeFrom(Config.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<Config.Rule.Builder>

    • mergeFrom

      public Config.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<Config.Rule.Builder>
      Throws:
      IOException

    • getHeader

      public String getHeader()
       Specifies that a match will be performed on the value of a header or a cookie.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeader in interface Config.RuleOrBuilder
      Returns:
      The header.

    • getHeaderBytes

      public com.google.protobuf.ByteString getHeaderBytes()
       Specifies that a match will be performed on the value of a header or a cookie.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Specified by:
      getHeaderBytes in interface Config.RuleOrBuilder
      Returns:
      The bytes for header.

    • setHeader

      public Config.Rule.Builder setHeader(String value)
       Specifies that a match will be performed on the value of a header or a cookie.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The header to set.
      Returns:
      This builder for chaining.

    • clearHeader

      public Config.Rule.Builder clearHeader()
       Specifies that a match will be performed on the value of a header or a cookie.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setHeaderBytes

      public Config.Rule.Builder setHeaderBytes(com.google.protobuf.ByteString value)
       Specifies that a match will be performed on the value of a header or a cookie.

 The header to be extracted.
      string header = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for header to set.
      Returns:
      This builder for chaining.

    • getCookie

      public String getCookie()
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Specified by:
      getCookie in interface Config.RuleOrBuilder
      Returns:
      The cookie.

    • getCookieBytes

      public com.google.protobuf.ByteString getCookieBytes()
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Specified by:
      getCookieBytes in interface Config.RuleOrBuilder
      Returns:
      The bytes for cookie.

    • setCookie

      public Config.Rule.Builder setCookie(String value)
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The cookie to set.
      Returns:
      This builder for chaining.

    • clearCookie

      public Config.Rule.Builder clearCookie()
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setCookieBytes

      public Config.Rule.Builder setCookieBytes(com.google.protobuf.ByteString value)
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for cookie to set.
      Returns:
      This builder for chaining.

    • hasOnHeaderPresent

      public boolean hasOnHeaderPresent()
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      hasOnHeaderPresent in interface Config.RuleOrBuilder
      Returns:
      Whether the onHeaderPresent field is set.

    • getOnHeaderPresent

      public Config.KeyValuePair getOnHeaderPresent()
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getOnHeaderPresent in interface Config.RuleOrBuilder
      Returns:
      The onHeaderPresent.

    • setOnHeaderPresent

      public Config.Rule.Builder setOnHeaderPresent(Config.KeyValuePair value)
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }

    • setOnHeaderPresent

      public Config.Rule.Builder setOnHeaderPresent(Config.KeyValuePair.Builder builderForValue)
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }

    • mergeOnHeaderPresent

      public Config.Rule.Builder mergeOnHeaderPresent(Config.KeyValuePair value)
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }

    • clearOnHeaderPresent

      public Config.Rule.Builder clearOnHeaderPresent()
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }

    • getOnHeaderPresentBuilder

      public Config.KeyValuePair.Builder getOnHeaderPresentBuilder()
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }

    • getOnHeaderPresentOrBuilder

      public Config.KeyValuePairOrBuilder getOnHeaderPresentOrBuilder()
       If the header or cookie is present, apply this metadata ``KeyValuePair``.

 If the value in the ``KeyValuePair`` is non-empty, it'll be used instead
 of the header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getOnHeaderPresentOrBuilder in interface Config.RuleOrBuilder

    • hasOnHeaderMissing

      public boolean hasOnHeaderMissing()
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      hasOnHeaderMissing in interface Config.RuleOrBuilder
      Returns:
      Whether the onHeaderMissing field is set.

    • getOnHeaderMissing

      public Config.KeyValuePair getOnHeaderMissing()
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getOnHeaderMissing in interface Config.RuleOrBuilder
      Returns:
      The onHeaderMissing.

    • setOnHeaderMissing

      public Config.Rule.Builder setOnHeaderMissing(Config.KeyValuePair value)
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }

    • setOnHeaderMissing

      public Config.Rule.Builder setOnHeaderMissing(Config.KeyValuePair.Builder builderForValue)
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }

    • mergeOnHeaderMissing

      public Config.Rule.Builder mergeOnHeaderMissing(Config.KeyValuePair value)
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }

    • clearOnHeaderMissing

      public Config.Rule.Builder clearOnHeaderMissing()
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }

    • getOnHeaderMissingBuilder

      public Config.KeyValuePair.Builder getOnHeaderMissingBuilder()
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }

    • getOnHeaderMissingOrBuilder

      public Config.KeyValuePairOrBuilder getOnHeaderMissingOrBuilder()
       If the header or cookie is not present, apply this metadata ``KeyValuePair``.

 The value in the ``KeyValuePair`` must be set, since it'll be used in lieu
 of the missing header or cookie value.
      .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getOnHeaderMissingOrBuilder in interface Config.RuleOrBuilder

    • getRemove

      public boolean getRemove()
       Whether or not to remove the header after a rule is applied.

 This prevents headers from leaking.
 This field is not supported in case of a cookie.
      bool remove = 4;
      Specified by:
      getRemove in interface Config.RuleOrBuilder
      Returns:
      The remove.

    • setRemove

      public Config.Rule.Builder setRemove(boolean value)
       Whether or not to remove the header after a rule is applied.

 This prevents headers from leaking.
 This field is not supported in case of a cookie.
      bool remove = 4;
      Parameters:
      value - The remove to set.
      Returns:
      This builder for chaining.

    • clearRemove

      public Config.Rule.Builder clearRemove()
       Whether or not to remove the header after a rule is applied.

 This prevents headers from leaking.
 This field is not supported in case of a cookie.
      bool remove = 4;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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