envoy.config.filter.http.rate_limit.v2

Class RateLimitOuterClass.RateLimit.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RateLimitOuterClass.RateLimit.Builder>

envoy.config.filter.http.rate_limit.v2.RateLimitOuterClass.RateLimit.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitOuterClass.RateLimitOrBuilder, Cloneable

Enclosing class:

RateLimitOuterClass.RateLimit

public static final class RateLimitOuterClass.RateLimit.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitOuterClass.RateLimit.Builder>
implements RateLimitOuterClass.RateLimitOrBuilder

Protobuf type envoy.config.filter.http.rate_limit.v2.RateLimit

Method Summary

Modifier and Type	Method and Description
RateLimitOuterClass.RateLimit.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RateLimitOuterClass.RateLimit	build()
RateLimitOuterClass.RateLimit	buildPartial()
RateLimitOuterClass.RateLimit.Builder	clear()
RateLimitOuterClass.RateLimit.Builder	clearDomain() The rate limit domain to use when calling the rate limit service.
RateLimitOuterClass.RateLimit.Builder	clearFailureModeDeny() The filter's behaviour in case the rate limiting service does not respond back.
RateLimitOuterClass.RateLimit.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RateLimitOuterClass.RateLimit.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RateLimitOuterClass.RateLimit.Builder	clearRequestType() The type of requests the filter should apply to.
RateLimitOuterClass.RateLimit.Builder	clearStage() Specifies the rate limit configurations to be applied with the same stage number.
RateLimitOuterClass.RateLimit.Builder	clearTimeout() The timeout in milliseconds for the rate limit service RPC.
RateLimitOuterClass.RateLimit.Builder	clone()
RateLimitOuterClass.RateLimit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getDomain() The rate limit domain to use when calling the rate limit service.
com.google.protobuf.ByteString	getDomainBytes() The rate limit domain to use when calling the rate limit service.
boolean	getFailureModeDeny() The filter's behaviour in case the rate limiting service does not respond back.
String	getRequestType() The type of requests the filter should apply to.
com.google.protobuf.ByteString	getRequestTypeBytes() The type of requests the filter should apply to.
int	getStage() Specifies the rate limit configurations to be applied with the same stage number.
com.google.protobuf.Duration	getTimeout() The timeout in milliseconds for the rate limit service RPC.
com.google.protobuf.Duration.Builder	getTimeoutBuilder() The timeout in milliseconds for the rate limit service RPC.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() The timeout in milliseconds for the rate limit service RPC.
boolean	hasTimeout() The timeout in milliseconds for the rate limit service RPC.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RateLimitOuterClass.RateLimit.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimitOuterClass.RateLimit.Builder	mergeFrom(com.google.protobuf.Message other)
RateLimitOuterClass.RateLimit.Builder	mergeFrom(RateLimitOuterClass.RateLimit other)
RateLimitOuterClass.RateLimit.Builder	mergeTimeout(com.google.protobuf.Duration value) The timeout in milliseconds for the rate limit service RPC.
RateLimitOuterClass.RateLimit.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RateLimitOuterClass.RateLimit.Builder	setDomain(String value) The rate limit domain to use when calling the rate limit service.
RateLimitOuterClass.RateLimit.Builder	setDomainBytes(com.google.protobuf.ByteString value) The rate limit domain to use when calling the rate limit service.
RateLimitOuterClass.RateLimit.Builder	setFailureModeDeny(boolean value) The filter's behaviour in case the rate limiting service does not respond back.
RateLimitOuterClass.RateLimit.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RateLimitOuterClass.RateLimit.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RateLimitOuterClass.RateLimit.Builder	setRequestType(String value) The type of requests the filter should apply to.
RateLimitOuterClass.RateLimit.Builder	setRequestTypeBytes(com.google.protobuf.ByteString value) The type of requests the filter should apply to.
RateLimitOuterClass.RateLimit.Builder	setStage(int value) Specifies the rate limit configurations to be applied with the same stage number.
RateLimitOuterClass.RateLimit.Builder	setTimeout(com.google.protobuf.Duration.Builder builderForValue) The timeout in milliseconds for the rate limit service RPC.
RateLimitOuterClass.RateLimit.Builder	setTimeout(com.google.protobuf.Duration value) The timeout in milliseconds for the rate limit service RPC.
RateLimitOuterClass.RateLimit.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

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<RateLimitOuterClass.RateLimit.Builder>

clear

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

getDefaultInstanceForType

public RateLimitOuterClass.RateLimit getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RateLimitOuterClass.RateLimit build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RateLimitOuterClass.RateLimit buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public RateLimitOuterClass.RateLimit.Builder mergeFrom(RateLimitOuterClass.RateLimit other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitOuterClass.RateLimit.Builder>

mergeFrom

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

Throws:

IOException

getDomain

public String getDomain()

 The rate limit domain to use when calling the rate limit service.
 

string domain = 1 [(.validate.rules) = { ... }

Specified by:

getDomain in interface RateLimitOuterClass.RateLimitOrBuilder

getDomainBytes

public com.google.protobuf.ByteString getDomainBytes()

 The rate limit domain to use when calling the rate limit service.
 

string domain = 1 [(.validate.rules) = { ... }

Specified by:

getDomainBytes in interface RateLimitOuterClass.RateLimitOrBuilder

setDomain

public RateLimitOuterClass.RateLimit.Builder setDomain(String value)

 The rate limit domain to use when calling the rate limit service.
 

string domain = 1 [(.validate.rules) = { ... }

clearDomain

public RateLimitOuterClass.RateLimit.Builder clearDomain()

 The rate limit domain to use when calling the rate limit service.
 

string domain = 1 [(.validate.rules) = { ... }

setDomainBytes

public RateLimitOuterClass.RateLimit.Builder setDomainBytes(com.google.protobuf.ByteString value)

 The rate limit domain to use when calling the rate limit service.
 

string domain = 1 [(.validate.rules) = { ... }

getStage

public int getStage()

 Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
 

uint32 stage = 2 [(.validate.rules) = { ... }

Specified by:

getStage in interface RateLimitOuterClass.RateLimitOrBuilder

setStage

public RateLimitOuterClass.RateLimit.Builder setStage(int value)

 Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
 

uint32 stage = 2 [(.validate.rules) = { ... }

clearStage

public RateLimitOuterClass.RateLimit.Builder clearStage()

 Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
 

uint32 stage = 2 [(.validate.rules) = { ... }

getRequestType

public String getRequestType()

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3;

Specified by:

getRequestType in interface RateLimitOuterClass.RateLimitOrBuilder

getRequestTypeBytes

public com.google.protobuf.ByteString getRequestTypeBytes()

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3;

Specified by:

getRequestTypeBytes in interface RateLimitOuterClass.RateLimitOrBuilder

setRequestType

public RateLimitOuterClass.RateLimit.Builder setRequestType(String value)

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3;

clearRequestType

public RateLimitOuterClass.RateLimit.Builder clearRequestType()

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3;

setRequestTypeBytes

public RateLimitOuterClass.RateLimit.Builder setRequestTypeBytes(com.google.protobuf.ByteString value)

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3;

hasTimeout

public boolean hasTimeout()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

Specified by:

hasTimeout in interface RateLimitOuterClass.RateLimitOrBuilder

getTimeout

public com.google.protobuf.Duration getTimeout()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

Specified by:

getTimeout in interface RateLimitOuterClass.RateLimitOrBuilder

setTimeout

public RateLimitOuterClass.RateLimit.Builder setTimeout(com.google.protobuf.Duration value)

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

setTimeout

public RateLimitOuterClass.RateLimit.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

mergeTimeout

public RateLimitOuterClass.RateLimit.Builder mergeTimeout(com.google.protobuf.Duration value)

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

clearTimeout

public RateLimitOuterClass.RateLimit.Builder clearTimeout()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

getTimeoutBuilder

public com.google.protobuf.Duration.Builder getTimeoutBuilder()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

getTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4 [(.gogoproto.stdduration) = true];

Specified by:

getTimeoutOrBuilder in interface RateLimitOuterClass.RateLimitOrBuilder

getFailureModeDeny

public boolean getFailureModeDeny()

 The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
 

bool failure_mode_deny = 5;

Specified by:

getFailureModeDeny in interface RateLimitOuterClass.RateLimitOrBuilder

setFailureModeDeny

public RateLimitOuterClass.RateLimit.Builder setFailureModeDeny(boolean value)

 The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
 

bool failure_mode_deny = 5;

clearFailureModeDeny

public RateLimitOuterClass.RateLimit.Builder clearFailureModeDeny()

 The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
 

bool failure_mode_deny = 5;

setUnknownFields

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

mergeUnknownFields

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