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

Class RateLimitConfig.Action.RequestHeaders.Builder

    • 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<RateLimitConfig.Action.RequestHeaders.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<RateLimitConfig.Action.RequestHeaders.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • getHeaderName

        public String getHeaderName()
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderName in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The headerName.

      • getHeaderNameBytes

        public com.google.protobuf.ByteString getHeaderNameBytes()
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderNameBytes in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The bytes for headerName.

      • setHeaderName

        public RateLimitConfig.Action.RequestHeaders.Builder setHeaderName​(String value)
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The headerName to set.
        Returns:
        This builder for chaining.

      • clearHeaderName

        public RateLimitConfig.Action.RequestHeaders.Builder clearHeaderName()
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setHeaderNameBytes

        public RateLimitConfig.Action.RequestHeaders.Builder setHeaderNameBytes​(com.google.protobuf.ByteString value)
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for headerName to set.
        Returns:
        This builder for chaining.

      • setDescriptorKey

        public RateLimitConfig.Action.RequestHeaders.Builder setDescriptorKey​(String value)
         The key to use in the descriptor entry.
        string descriptor_key = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The descriptorKey to set.
        Returns:
        This builder for chaining.

      • clearDescriptorKey

        public RateLimitConfig.Action.RequestHeaders.Builder clearDescriptorKey()
         The key to use in the descriptor entry.
        string descriptor_key = 2 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setDescriptorKeyBytes

        public RateLimitConfig.Action.RequestHeaders.Builder setDescriptorKeyBytes​(com.google.protobuf.ByteString value)
         The key to use in the descriptor entry.
        string descriptor_key = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for descriptorKey to set.
        Returns:
        This builder for chaining.

      • getSkipIfAbsent

        public boolean getSkipIfAbsent()
         If set to true, Envoy skips the descriptor while calling rate limiting service
 when header is not present in the request. By default it skips calling the
 rate limiting service if this header is not present in the request.
        bool skip_if_absent = 3;
        Specified by:
        getSkipIfAbsent in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The skipIfAbsent.

      • setSkipIfAbsent

        public RateLimitConfig.Action.RequestHeaders.Builder setSkipIfAbsent​(boolean value)
         If set to true, Envoy skips the descriptor while calling rate limiting service
 when header is not present in the request. By default it skips calling the
 rate limiting service if this header is not present in the request.
        bool skip_if_absent = 3;
        Parameters:
        value - The skipIfAbsent to set.
        Returns:
        This builder for chaining.

      • clearSkipIfAbsent

        public RateLimitConfig.Action.RequestHeaders.Builder clearSkipIfAbsent()
         If set to true, Envoy skips the descriptor while calling rate limiting service
 when header is not present in the request. By default it skips calling the
 rate limiting service if this header is not present in the request.
        bool skip_if_absent = 3;
        Returns:
        This builder for chaining.