Package io.envoyproxy.envoy.extensions.common.ratelimit.v3

Class LocalRateLimitDescriptor.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimitDescriptor.Builder>
io.envoyproxy.envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalRateLimitDescriptorOrBuilder, Cloneable
Enclosing class:
LocalRateLimitDescriptor
public static final class LocalRateLimitDescriptor.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimitDescriptor.Builder> implements LocalRateLimitDescriptorOrBuilder
 Configuration used to enable local rate limiting.

 .. note::
   The ``LocalRateLimitDescriptor`` is used to configure a local rate limit rule with a token
   bucket algorithm. The ``RateLimitDescriptor`` is used to represent a list of symbols that
   are used to match against the rate limit rule.
Protobuf type envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public LocalRateLimitDescriptor.Builder mergeFrom(LocalRateLimitDescriptor other)

    • isInitialized

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

    • mergeFrom

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

    • getEntriesList

      public List<RateLimitDescriptor.Entry> getEntriesList()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesList in interface LocalRateLimitDescriptorOrBuilder

    • getEntriesCount

      public int getEntriesCount()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesCount in interface LocalRateLimitDescriptorOrBuilder

    • getEntries

      public RateLimitDescriptor.Entry getEntries(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntries in interface LocalRateLimitDescriptorOrBuilder

    • setEntries

      public LocalRateLimitDescriptor.Builder setEntries(int index, RateLimitDescriptor.Entry value)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • setEntries

      public LocalRateLimitDescriptor.Builder setEntries(int index, RateLimitDescriptor.Entry.Builder builderForValue)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addEntries

      public LocalRateLimitDescriptor.Builder addEntries(RateLimitDescriptor.Entry value)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addEntries

      public LocalRateLimitDescriptor.Builder addEntries(int index, RateLimitDescriptor.Entry value)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addEntries

      public LocalRateLimitDescriptor.Builder addEntries(RateLimitDescriptor.Entry.Builder builderForValue)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addEntries

      public LocalRateLimitDescriptor.Builder addEntries(int index, RateLimitDescriptor.Entry.Builder builderForValue)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addAllEntries

      public LocalRateLimitDescriptor.Builder addAllEntries(Iterable<? extends RateLimitDescriptor.Entry> values)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • clearEntries

      public LocalRateLimitDescriptor.Builder clearEntries()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • removeEntries

      public LocalRateLimitDescriptor.Builder removeEntries(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • getEntriesBuilder

      public RateLimitDescriptor.Entry.Builder getEntriesBuilder(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • getEntriesOrBuilder

      public RateLimitDescriptor.EntryOrBuilder getEntriesOrBuilder(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesOrBuilder in interface LocalRateLimitDescriptorOrBuilder

    • getEntriesOrBuilderList

      public List<? extends RateLimitDescriptor.EntryOrBuilder> getEntriesOrBuilderList()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesOrBuilderList in interface LocalRateLimitDescriptorOrBuilder

    • addEntriesBuilder

      public RateLimitDescriptor.Entry.Builder addEntriesBuilder()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • addEntriesBuilder

      public RateLimitDescriptor.Entry.Builder addEntriesBuilder(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • getEntriesBuilderList

      public List<RateLimitDescriptor.Entry.Builder> getEntriesBuilderList()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

    • hasTokenBucket

      public boolean hasTokenBucket()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      hasTokenBucket in interface LocalRateLimitDescriptorOrBuilder
      Returns:
      Whether the tokenBucket field is set.

    • getTokenBucket

      public TokenBucket getTokenBucket()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucket in interface LocalRateLimitDescriptorOrBuilder
      Returns:
      The tokenBucket.

    • setTokenBucket

      public LocalRateLimitDescriptor.Builder setTokenBucket(TokenBucket value)
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • setTokenBucket

      public LocalRateLimitDescriptor.Builder setTokenBucket(TokenBucket.Builder builderForValue)
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • mergeTokenBucket

      public LocalRateLimitDescriptor.Builder mergeTokenBucket(TokenBucket value)
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • clearTokenBucket

      public LocalRateLimitDescriptor.Builder clearTokenBucket()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • getTokenBucketBuilder

      public TokenBucket.Builder getTokenBucketBuilder()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • getTokenBucketOrBuilder

      public TokenBucketOrBuilder getTokenBucketOrBuilder()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucketOrBuilder in interface LocalRateLimitDescriptorOrBuilder

    • setUnknownFields

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

    • mergeUnknownFields

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