envoy.config.ratelimit.v2

Interface Rls.RateLimitServiceConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Rls.RateLimitServiceConfig, Rls.RateLimitServiceConfig.Builder

Enclosing class:

Rls

public static interface Rls.RateLimitServiceConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getClusterName() Deprecated.
com.google.protobuf.ByteString	getClusterNameBytes() Deprecated.
GrpcServiceOuterClass.GrpcService	getGrpcService() 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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getClusterName

@Deprecated
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) = { ... }

getClusterNameBytes

@Deprecated
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) = { ... }

hasGrpcService

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;

getGrpcService

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;

getGrpcServiceOrBuilder

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;

getUseDataPlaneProto

@Deprecated
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];

getServiceSpecifierCase

Rls.RateLimitServiceConfig.ServiceSpecifierCase getServiceSpecifierCase()