envoy.config.ratelimit.v2

Class Rls.RateLimitServiceConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.config.ratelimit.v2.Rls.RateLimitServiceConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Rls.RateLimitServiceConfigOrBuilder, Serializable

Enclosing class:

Rls

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

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

Protobuf type envoy.config.ratelimit.v2.RateLimitServiceConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rls.RateLimitServiceConfig.Builder Rate limit :ref:`configuration overview <config_rate_limit_service>`.
static class	Rls.RateLimitServiceConfig.ServiceSpecifierCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_NAME_FIELD_NUMBER
static int	GRPC_SERVICE_FIELD_NUMBER
static int	USE_DATA_PLANE_PROTO_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClusterName() Deprecated.
com.google.protobuf.ByteString	getClusterNameBytes() Deprecated.
static Rls.RateLimitServiceConfig	getDefaultInstance()
Rls.RateLimitServiceConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Rls.RateLimitServiceConfig>	getParserForType()
int	getSerializedSize()
Rls.RateLimitServiceConfig.ServiceSpecifierCase	getServiceSpecifierCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUseDataPlaneProto() Deprecated.
boolean	hasGrpcService() Specifies the gRPC service that hosts the rate limit service.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Rls.RateLimitServiceConfig.Builder	newBuilder()
static Rls.RateLimitServiceConfig.Builder	newBuilder(Rls.RateLimitServiceConfig prototype)
Rls.RateLimitServiceConfig.Builder	newBuilderForType()
protected Rls.RateLimitServiceConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Rls.RateLimitServiceConfig	parseDelimitedFrom(InputStream input)
static Rls.RateLimitServiceConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Rls.RateLimitServiceConfig	parseFrom(byte[] data)
static Rls.RateLimitServiceConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Rls.RateLimitServiceConfig	parseFrom(ByteBuffer data)
static Rls.RateLimitServiceConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Rls.RateLimitServiceConfig	parseFrom(com.google.protobuf.ByteString data)
static Rls.RateLimitServiceConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Rls.RateLimitServiceConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Rls.RateLimitServiceConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Rls.RateLimitServiceConfig	parseFrom(InputStream input)
static Rls.RateLimitServiceConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Rls.RateLimitServiceConfig>	parser()
Rls.RateLimitServiceConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

GRPC_SERVICE_FIELD_NUMBER

public static final int GRPC_SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

USE_DATA_PLANE_PROTO_FIELD_NUMBER

public static final int USE_DATA_PLANE_PROTO_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getServiceSpecifierCase

public Rls.RateLimitServiceConfig.ServiceSpecifierCase getServiceSpecifierCase()

Specified by:

getServiceSpecifierCase in interface Rls.RateLimitServiceConfigOrBuilder

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Rls.RateLimitServiceConfig parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Rls.RateLimitServiceConfig parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Rls.RateLimitServiceConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public Rls.RateLimitServiceConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Rls.RateLimitServiceConfig.Builder newBuilder()

newBuilder

public static Rls.RateLimitServiceConfig.Builder newBuilder(Rls.RateLimitServiceConfig prototype)

toBuilder

public Rls.RateLimitServiceConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Rls.RateLimitServiceConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Rls.RateLimitServiceConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<Rls.RateLimitServiceConfig> parser()

getParserForType

public com.google.protobuf.Parser<Rls.RateLimitServiceConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Rls.RateLimitServiceConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder