envoy.config.ratelimit.v2

Class Rls.RateLimitServiceConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<Rls.RateLimitServiceConfig.Builder>

envoy.config.ratelimit.v2.Rls.RateLimitServiceConfig.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Rls.RateLimitServiceConfigOrBuilder, Cloneable

Enclosing class:

Rls.RateLimitServiceConfig

public static final class Rls.RateLimitServiceConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Rls.RateLimitServiceConfig.Builder>
implements Rls.RateLimitServiceConfigOrBuilder

 Rate limit :ref:`configuration overview <config_rate_limit_service>`.
 

Protobuf type envoy.config.ratelimit.v2.RateLimitServiceConfig

Method Summary

Modifier and Type	Method and Description
Rls.RateLimitServiceConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Rls.RateLimitServiceConfig	build()
Rls.RateLimitServiceConfig	buildPartial()
Rls.RateLimitServiceConfig.Builder	clear()
Rls.RateLimitServiceConfig.Builder	clearClusterName() Deprecated.
Rls.RateLimitServiceConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Rls.RateLimitServiceConfig.Builder	clearGrpcService() Specifies the gRPC service that hosts the rate limit service.
Rls.RateLimitServiceConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Rls.RateLimitServiceConfig.Builder	clearServiceSpecifier()
Rls.RateLimitServiceConfig.Builder	clearUseDataPlaneProto() Deprecated.
Rls.RateLimitServiceConfig.Builder	clone()
String	getClusterName() Deprecated.
com.google.protobuf.ByteString	getClusterNameBytes() Deprecated.
Rls.RateLimitServiceConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
GrpcServiceOuterClass.GrpcService	getGrpcService() Specifies the gRPC service that hosts the rate limit service.
GrpcServiceOuterClass.GrpcService.Builder	getGrpcServiceBuilder() Specifies the gRPC service that hosts the rate limit service.
GrpcServiceOuterClass.GrpcServiceOrBuilder	getGrpcServiceOrBuilder() Specifies the gRPC service that hosts the rate limit service.
Rls.RateLimitServiceConfig.ServiceSpecifierCase	getServiceSpecifierCase()
boolean	getUseDataPlaneProto() Deprecated.
boolean	hasGrpcService() Specifies the gRPC service that hosts the rate limit service.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Rls.RateLimitServiceConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Rls.RateLimitServiceConfig.Builder	mergeFrom(com.google.protobuf.Message other)
Rls.RateLimitServiceConfig.Builder	mergeFrom(Rls.RateLimitServiceConfig other)
Rls.RateLimitServiceConfig.Builder	mergeGrpcService(GrpcServiceOuterClass.GrpcService value) Specifies the gRPC service that hosts the rate limit service.
Rls.RateLimitServiceConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Rls.RateLimitServiceConfig.Builder	setClusterName(String value) Deprecated.
Rls.RateLimitServiceConfig.Builder	setClusterNameBytes(com.google.protobuf.ByteString value) Deprecated.
Rls.RateLimitServiceConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Rls.RateLimitServiceConfig.Builder	setGrpcService(GrpcServiceOuterClass.GrpcService.Builder builderForValue) Specifies the gRPC service that hosts the rate limit service.
Rls.RateLimitServiceConfig.Builder	setGrpcService(GrpcServiceOuterClass.GrpcService value) Specifies the gRPC service that hosts the rate limit service.
Rls.RateLimitServiceConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Rls.RateLimitServiceConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Rls.RateLimitServiceConfig.Builder	setUseDataPlaneProto(boolean value) Deprecated.

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<Rls.RateLimitServiceConfig.Builder>

clear

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

getDefaultInstanceForType

public Rls.RateLimitServiceConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Rls.RateLimitServiceConfig build()

Specified by:

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

Specified by:

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

buildPartial

public Rls.RateLimitServiceConfig buildPartial()

Specified by:

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

Specified by:

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

clone

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

setField

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

clearField

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

clearOneof

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

setRepeatedField

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

addRepeatedField

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

mergeFrom

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

mergeFrom

public Rls.RateLimitServiceConfig.Builder mergeFrom(Rls.RateLimitServiceConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Rls.RateLimitServiceConfig.Builder>

mergeFrom

public Rls.RateLimitServiceConfig.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<Rls.RateLimitServiceConfig.Builder>

Throws:

IOException

getServiceSpecifierCase

public Rls.RateLimitServiceConfig.ServiceSpecifierCase getServiceSpecifierCase()

Specified by:

getServiceSpecifierCase in interface Rls.RateLimitServiceConfigOrBuilder

clearServiceSpecifier

public Rls.RateLimitServiceConfig.Builder clearServiceSpecifier()

getClusterName

@Deprecated
public String getClusterName()

Deprecated.

 Specifies the cluster manager cluster name that hosts the rate limit
 service. The client will connect to this cluster when it needs to make
 rate limit service requests. This field is deprecated and `grpc_service`
 should be used instead. The :ref:`Envoy gRPC client
 <envoy_api_field_core.GrpcService.envoy_grpc>` will be used when this field is
 specified.
 

string cluster_name = 1 [deprecated = true, (.validate.rules) = { ... }

Specified by:

getClusterName in interface Rls.RateLimitServiceConfigOrBuilder

getClusterNameBytes

@Deprecated
public com.google.protobuf.ByteString getClusterNameBytes()

Deprecated.

 Specifies the cluster manager cluster name that hosts the rate limit
 service. The client will connect to this cluster when it needs to make
 rate limit service requests. This field is deprecated and `grpc_service`
 should be used instead. The :ref:`Envoy gRPC client
 <envoy_api_field_core.GrpcService.envoy_grpc>` will be used when this field is
 specified.
 

string cluster_name = 1 [deprecated = true, (.validate.rules) = { ... }

Specified by:

getClusterNameBytes in interface Rls.RateLimitServiceConfigOrBuilder

setClusterName

@Deprecated
public Rls.RateLimitServiceConfig.Builder setClusterName(String value)

Deprecated.

 Specifies the cluster manager cluster name that hosts the rate limit
 service. The client will connect to this cluster when it needs to make
 rate limit service requests. This field is deprecated and `grpc_service`
 should be used instead. The :ref:`Envoy gRPC client
 <envoy_api_field_core.GrpcService.envoy_grpc>` will be used when this field is
 specified.
 

string cluster_name = 1 [deprecated = true, (.validate.rules) = { ... }

clearClusterName

@Deprecated
public Rls.RateLimitServiceConfig.Builder clearClusterName()

Deprecated.

 Specifies the cluster manager cluster name that hosts the rate limit
 service. The client will connect to this cluster when it needs to make
 rate limit service requests. This field is deprecated and `grpc_service`
 should be used instead. The :ref:`Envoy gRPC client
 <envoy_api_field_core.GrpcService.envoy_grpc>` will be used when this field is
 specified.
 

string cluster_name = 1 [deprecated = true, (.validate.rules) = { ... }

setClusterNameBytes

@Deprecated
public Rls.RateLimitServiceConfig.Builder setClusterNameBytes(com.google.protobuf.ByteString value)

Deprecated.

 Specifies the cluster manager cluster name that hosts the rate limit
 service. The client will connect to this cluster when it needs to make
 rate limit service requests. This field is deprecated and `grpc_service`
 should be used instead. The :ref:`Envoy gRPC client
 <envoy_api_field_core.GrpcService.envoy_grpc>` will be used when this field is
 specified.
 

string cluster_name = 1 [deprecated = true, (.validate.rules) = { ... }

hasGrpcService

public boolean hasGrpcService()

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

Specified by:

hasGrpcService in interface Rls.RateLimitServiceConfigOrBuilder

getGrpcService

public GrpcServiceOuterClass.GrpcService getGrpcService()

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

Specified by:

getGrpcService in interface Rls.RateLimitServiceConfigOrBuilder

setGrpcService

public Rls.RateLimitServiceConfig.Builder setGrpcService(GrpcServiceOuterClass.GrpcService value)

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

setGrpcService

public Rls.RateLimitServiceConfig.Builder setGrpcService(GrpcServiceOuterClass.GrpcService.Builder builderForValue)

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

mergeGrpcService

public Rls.RateLimitServiceConfig.Builder mergeGrpcService(GrpcServiceOuterClass.GrpcService value)

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

clearGrpcService

public Rls.RateLimitServiceConfig.Builder clearGrpcService()

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

getGrpcServiceBuilder

public GrpcServiceOuterClass.GrpcService.Builder getGrpcServiceBuilder()

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

getGrpcServiceOrBuilder

public GrpcServiceOuterClass.GrpcServiceOrBuilder getGrpcServiceOrBuilder()

 Specifies the gRPC service that hosts the rate limit service. The client
 will connect to this cluster when it needs to make rate limit service
 requests.
 

.envoy.api.v2.core.GrpcService grpc_service = 2;

Specified by:

getGrpcServiceOrBuilder in interface Rls.RateLimitServiceConfigOrBuilder

getUseDataPlaneProto

@Deprecated
public boolean getUseDataPlaneProto()

Deprecated.

 Specifies if Envoy should use the data-plane-api client
 :repo:`api/envoy/service/ratelimit/v2/rls.proto` or the legacy
 client :repo:`source/common/ratelimit/ratelimit.proto` when
 making requests to the rate limit service.
 .. note::
   The legacy client will be used by
   default until the start of the 1.9.0 release cycle. At the start of the
   1.9.0 release cycle this field will be removed and only the data-plane-api
   proto will be supported. This means that your rate limit service needs to
   have support for the data-plane-api proto by the start of the 1.9.0 release cycle.
   Lyft's `reference implementation <https://github.com/lyft/ratelimit>`_
   supports the data-plane-api version as of v1.1.0.
 

bool use_data_plane_proto = 3 [deprecated = true];

Specified by:

getUseDataPlaneProto in interface Rls.RateLimitServiceConfigOrBuilder

setUseDataPlaneProto

@Deprecated
public Rls.RateLimitServiceConfig.Builder setUseDataPlaneProto(boolean value)

Deprecated.

 Specifies if Envoy should use the data-plane-api client
 :repo:`api/envoy/service/ratelimit/v2/rls.proto` or the legacy
 client :repo:`source/common/ratelimit/ratelimit.proto` when
 making requests to the rate limit service.
 .. note::
   The legacy client will be used by
   default until the start of the 1.9.0 release cycle. At the start of the
   1.9.0 release cycle this field will be removed and only the data-plane-api
   proto will be supported. This means that your rate limit service needs to
   have support for the data-plane-api proto by the start of the 1.9.0 release cycle.
   Lyft's `reference implementation <https://github.com/lyft/ratelimit>`_
   supports the data-plane-api version as of v1.1.0.
 

bool use_data_plane_proto = 3 [deprecated = true];

clearUseDataPlaneProto

@Deprecated
public Rls.RateLimitServiceConfig.Builder clearUseDataPlaneProto()

Deprecated.

 Specifies if Envoy should use the data-plane-api client
 :repo:`api/envoy/service/ratelimit/v2/rls.proto` or the legacy
 client :repo:`source/common/ratelimit/ratelimit.proto` when
 making requests to the rate limit service.
 .. note::
   The legacy client will be used by
   default until the start of the 1.9.0 release cycle. At the start of the
   1.9.0 release cycle this field will be removed and only the data-plane-api
   proto will be supported. This means that your rate limit service needs to
   have support for the data-plane-api proto by the start of the 1.9.0 release cycle.
   Lyft's `reference implementation <https://github.com/lyft/ratelimit>`_
   supports the data-plane-api version as of v1.1.0.
 

bool use_data_plane_proto = 3 [deprecated = true];

setUnknownFields

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

mergeUnknownFields

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