Class RateLimit.Action.HeaderValueMatch.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder>
com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder>
io.envoyproxy.envoy.config.route.v3.RateLimit.Action.HeaderValueMatch.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.HeaderValueMatchOrBuilder, Cloneable
Enclosing class:
RateLimit.Action.HeaderValueMatch
public static final class RateLimit.Action.HeaderValueMatch.Builder extends com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder> implements RateLimit.Action.HeaderValueMatchOrBuilder
The following descriptor entry is appended to the descriptor:

.. code-block:: cpp

("header_match", "<descriptor_value>")
Protobuf type envoy.config.route.v3.RateLimit.Action.HeaderValueMatch

  • Field Details

    • bitField0_

      private int bitField0_

    • descriptorKey_

      private Object descriptorKey_

    • descriptorValue_

      private Object descriptorValue_

    • expectMatch_

      private com.google.protobuf.BoolValue expectMatch_

    • expectMatchBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue, com.google.protobuf.BoolValue.Builder, com.google.protobuf.BoolValueOrBuilder> expectMatchBuilder_

    • headers_

      private List<HeaderMatcher> headers_

    • headersBuilder_

      private com.google.protobuf.RepeatedFieldBuilder<HeaderMatcher, HeaderMatcher.Builder, HeaderMatcherOrBuilder> headersBuilder_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder>

    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()

    • clear

      public RateLimit.Action.HeaderValueMatch.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.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.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.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder>

    • getDefaultInstanceForType

      public RateLimit.Action.HeaderValueMatch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • buildPartialRepeatedFields

      private void buildPartialRepeatedFields(RateLimit.Action.HeaderValueMatch result)

    • buildPartial0

      private void buildPartial0(RateLimit.Action.HeaderValueMatch result)

    • mergeFrom

      public RateLimit.Action.HeaderValueMatch.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<RateLimit.Action.HeaderValueMatch.Builder>

    • mergeFrom

      public RateLimit.Action.HeaderValueMatch.Builder mergeFrom(RateLimit.Action.HeaderValueMatch other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.HeaderValueMatch.Builder>

    • mergeFrom

      public RateLimit.Action.HeaderValueMatch.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<RateLimit.Action.HeaderValueMatch.Builder>
      Throws:
      IOException

    • getDescriptorKey

      public String getDescriptorKey()
      The key to use in the descriptor entry. Defaults to ``header_match``.
      string descriptor_key = 4;
      Specified by:
      getDescriptorKey in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      The descriptorKey.

    • getDescriptorKeyBytes

      public com.google.protobuf.ByteString getDescriptorKeyBytes()
      The key to use in the descriptor entry. Defaults to ``header_match``.
      string descriptor_key = 4;
      Specified by:
      getDescriptorKeyBytes in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      The bytes for descriptorKey.

    • setDescriptorKey

      public RateLimit.Action.HeaderValueMatch.Builder setDescriptorKey(String value)
      The key to use in the descriptor entry. Defaults to ``header_match``.
      string descriptor_key = 4;
      Parameters:
      value - The descriptorKey to set.
      Returns:
      This builder for chaining.

    • clearDescriptorKey

      public RateLimit.Action.HeaderValueMatch.Builder clearDescriptorKey()
      The key to use in the descriptor entry. Defaults to ``header_match``.
      string descriptor_key = 4;
      Returns:
      This builder for chaining.

    • setDescriptorKeyBytes

      public RateLimit.Action.HeaderValueMatch.Builder setDescriptorKeyBytes(com.google.protobuf.ByteString value)
      The key to use in the descriptor entry. Defaults to ``header_match``.
      string descriptor_key = 4;
      Parameters:
      value - The bytes for descriptorKey to set.
      Returns:
      This builder for chaining.

    • getDescriptorValue

      public String getDescriptorValue()
      The value to use in the descriptor entry.
      string descriptor_value = 1 [(.validate.rules) = { ... }
      Specified by:
      getDescriptorValue in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      The descriptorValue.

    • getDescriptorValueBytes

      public com.google.protobuf.ByteString getDescriptorValueBytes()
      The value to use in the descriptor entry.
      string descriptor_value = 1 [(.validate.rules) = { ... }
      Specified by:
      getDescriptorValueBytes in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      The bytes for descriptorValue.

    • setDescriptorValue

      public RateLimit.Action.HeaderValueMatch.Builder setDescriptorValue(String value)
      The value to use in the descriptor entry.
      string descriptor_value = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The descriptorValue to set.
      Returns:
      This builder for chaining.

    • clearDescriptorValue

      public RateLimit.Action.HeaderValueMatch.Builder clearDescriptorValue()
      The value to use in the descriptor entry.
      string descriptor_value = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setDescriptorValueBytes

      public RateLimit.Action.HeaderValueMatch.Builder setDescriptorValueBytes(com.google.protobuf.ByteString value)
      The value to use in the descriptor entry.
      string descriptor_value = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for descriptorValue to set.
      Returns:
      This builder for chaining.

    • hasExpectMatch

      public boolean hasExpectMatch()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;
      Specified by:
      hasExpectMatch in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      Whether the expectMatch field is set.

    • getExpectMatch

      public com.google.protobuf.BoolValue getExpectMatch()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;
      Specified by:
      getExpectMatch in interface RateLimit.Action.HeaderValueMatchOrBuilder
      Returns:
      The expectMatch.

    • setExpectMatch

      public RateLimit.Action.HeaderValueMatch.Builder setExpectMatch(com.google.protobuf.BoolValue value)
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • setExpectMatch

      public RateLimit.Action.HeaderValueMatch.Builder setExpectMatch(com.google.protobuf.BoolValue.Builder builderForValue)
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • mergeExpectMatch

      public RateLimit.Action.HeaderValueMatch.Builder mergeExpectMatch(com.google.protobuf.BoolValue value)
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • clearExpectMatch

      public RateLimit.Action.HeaderValueMatch.Builder clearExpectMatch()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • getExpectMatchBuilder

      public com.google.protobuf.BoolValue.Builder getExpectMatchBuilder()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • getExpectMatchOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getExpectMatchOrBuilder()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;
      Specified by:
      getExpectMatchOrBuilder in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • internalGetExpectMatchFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.BoolValue, com.google.protobuf.BoolValue.Builder, com.google.protobuf.BoolValueOrBuilder> internalGetExpectMatchFieldBuilder()
      If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
      .google.protobuf.BoolValue expect_match = 2;

    • ensureHeadersIsMutable

      private void ensureHeadersIsMutable()

    • getHeadersList

      public List<HeaderMatcher> getHeadersList()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersList in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • getHeadersCount

      public int getHeadersCount()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersCount in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • getHeaders

      public HeaderMatcher getHeaders(int index)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeaders in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • setHeaders

      public RateLimit.Action.HeaderValueMatch.Builder setHeaders(int index, HeaderMatcher value)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • setHeaders

      public RateLimit.Action.HeaderValueMatch.Builder setHeaders(int index, HeaderMatcher.Builder builderForValue)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addHeaders

      public RateLimit.Action.HeaderValueMatch.Builder addHeaders(HeaderMatcher value)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addHeaders

      public RateLimit.Action.HeaderValueMatch.Builder addHeaders(int index, HeaderMatcher value)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addHeaders

      public RateLimit.Action.HeaderValueMatch.Builder addHeaders(HeaderMatcher.Builder builderForValue)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addHeaders

      public RateLimit.Action.HeaderValueMatch.Builder addHeaders(int index, HeaderMatcher.Builder builderForValue)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addAllHeaders

      public RateLimit.Action.HeaderValueMatch.Builder addAllHeaders(Iterable<? extends HeaderMatcher> values)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • clearHeaders

      public RateLimit.Action.HeaderValueMatch.Builder clearHeaders()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • removeHeaders

      public RateLimit.Action.HeaderValueMatch.Builder removeHeaders(int index)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • getHeadersBuilder

      public HeaderMatcher.Builder getHeadersBuilder(int index)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • getHeadersOrBuilder

      public HeaderMatcherOrBuilder getHeadersOrBuilder(int index)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersOrBuilder in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • getHeadersOrBuilderList

      public List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
      Specified by:
      getHeadersOrBuilderList in interface RateLimit.Action.HeaderValueMatchOrBuilder

    • addHeadersBuilder

      public HeaderMatcher.Builder addHeadersBuilder()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • addHeadersBuilder

      public HeaderMatcher.Builder addHeadersBuilder(int index)
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • getHeadersBuilderList

      public List<HeaderMatcher.Builder> getHeadersBuilderList()
      Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
      repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }

    • internalGetHeadersFieldBuilder

      private com.google.protobuf.RepeatedFieldBuilder<HeaderMatcher, HeaderMatcher.Builder, HeaderMatcherOrBuilder> internalGetHeadersFieldBuilder()