Class RateLimitStrategy.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitStrategyOrBuilder, java.lang.Cloneable
    Enclosing class:
    RateLimitStrategy

    public static final class RateLimitStrategy.Builder
    extends com.google.protobuf.GeneratedMessage.Builder<RateLimitStrategy.Builder>
    implements RateLimitStrategyOrBuilder
    Protobuf type envoy.type.v3.RateLimitStrategy
    • Constructor Detail

      • Builder

        private Builder()
      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)
    • Method Detail

      • 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<RateLimitStrategy.Builder>
      • clear

        public RateLimitStrategy.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<RateLimitStrategy.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<RateLimitStrategy.Builder>
      • getDefaultInstanceForType

        public RateLimitStrategy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public RateLimitStrategy.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<RateLimitStrategy.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RateLimitStrategy.Builder>
      • mergeFrom

        public RateLimitStrategy.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<RateLimitStrategy.Builder>
        Throws:
        java.io.IOException
      • hasBlanketRule

        public boolean hasBlanketRule()
         Allow or Deny the requests.
         If unset, allow all.
         
        .envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
        Specified by:
        hasBlanketRule in interface RateLimitStrategyOrBuilder
        Returns:
        Whether the blanketRule field is set.
      • getBlanketRuleValue

        public int getBlanketRuleValue()
         Allow or Deny the requests.
         If unset, allow all.
         
        .envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
        Specified by:
        getBlanketRuleValue in interface RateLimitStrategyOrBuilder
        Returns:
        The enum numeric value on the wire for blanketRule.
      • setBlanketRuleValue

        public RateLimitStrategy.Builder setBlanketRuleValue​(int value)
         Allow or Deny the requests.
         If unset, allow all.
         
        .envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The enum numeric value on the wire for blanketRule to set.
        Returns:
        This builder for chaining.
      • setBlanketRule

        public RateLimitStrategy.Builder setBlanketRule​(RateLimitStrategy.BlanketRule value)
         Allow or Deny the requests.
         If unset, allow all.
         
        .envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The blanketRule to set.
        Returns:
        This builder for chaining.
      • clearBlanketRule

        public RateLimitStrategy.Builder clearBlanketRule()
         Allow or Deny the requests.
         If unset, allow all.
         
        .envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.
      • hasRequestsPerTimeUnit

        public boolean hasRequestsPerTimeUnit()
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
        Specified by:
        hasRequestsPerTimeUnit in interface RateLimitStrategyOrBuilder
        Returns:
        Whether the requestsPerTimeUnit field is set.
      • getRequestsPerTimeUnit

        public RateLimitStrategy.RequestsPerTimeUnit getRequestsPerTimeUnit()
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
        Specified by:
        getRequestsPerTimeUnit in interface RateLimitStrategyOrBuilder
        Returns:
        The requestsPerTimeUnit.
      • setRequestsPerTimeUnit

        public RateLimitStrategy.Builder setRequestsPerTimeUnit​(RateLimitStrategy.RequestsPerTimeUnit value)
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
      • setRequestsPerTimeUnit

        public RateLimitStrategy.Builder setRequestsPerTimeUnit​(RateLimitStrategy.RequestsPerTimeUnit.Builder builderForValue)
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
      • mergeRequestsPerTimeUnit

        public RateLimitStrategy.Builder mergeRequestsPerTimeUnit​(RateLimitStrategy.RequestsPerTimeUnit value)
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
      • clearRequestsPerTimeUnit

        public RateLimitStrategy.Builder clearRequestsPerTimeUnit()
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
      • getRequestsPerTimeUnitBuilder

        public RateLimitStrategy.RequestsPerTimeUnit.Builder getRequestsPerTimeUnitBuilder()
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
      • getRequestsPerTimeUnitOrBuilder

        public RateLimitStrategy.RequestsPerTimeUnitOrBuilder getRequestsPerTimeUnitOrBuilder()
         Best-effort limit of the number of requests per time unit, f.e. requests per second.
         Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit
         <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
         
        .envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
        Specified by:
        getRequestsPerTimeUnitOrBuilder in interface RateLimitStrategyOrBuilder
      • hasTokenBucket

        public boolean hasTokenBucket()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
        Specified by:
        hasTokenBucket in interface RateLimitStrategyOrBuilder
        Returns:
        Whether the tokenBucket field is set.
      • getTokenBucket

        public TokenBucket getTokenBucket()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
        Specified by:
        getTokenBucket in interface RateLimitStrategyOrBuilder
        Returns:
        The tokenBucket.
      • setTokenBucket

        public RateLimitStrategy.Builder setTokenBucket​(TokenBucket value)
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
      • setTokenBucket

        public RateLimitStrategy.Builder setTokenBucket​(TokenBucket.Builder builderForValue)
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
      • mergeTokenBucket

        public RateLimitStrategy.Builder mergeTokenBucket​(TokenBucket value)
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
      • clearTokenBucket

        public RateLimitStrategy.Builder clearTokenBucket()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
      • getTokenBucketBuilder

        public TokenBucket.Builder getTokenBucketBuilder()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
      • getTokenBucketOrBuilder

        public TokenBucketOrBuilder getTokenBucketOrBuilder()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;
        Specified by:
        getTokenBucketOrBuilder in interface RateLimitStrategyOrBuilder
      • getTokenBucketFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<TokenBucket,​TokenBucket.Builder,​TokenBucketOrBuilder> getTokenBucketFieldBuilder()
         Limit the requests by consuming tokens from the Token Bucket.
         Allow the same number of requests as the number of tokens available in
         the token bucket.
         
        .envoy.type.v3.TokenBucket token_bucket = 3;