com.tencent.polaris.client.pb

接口 RateLimitProto.RuleOrBuilder

所有超级接口:

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

所有已知实现类:

RateLimitProto.Rule, RateLimitProto.Rule.Builder

封闭类:

RateLimitProto

public static interface RateLimitProto.RuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

方法概要

限定符和类型	方法和说明
boolean	containsLabels(String key) 业务标签集合，通过KV进行匹配，全部匹配才使用该规则 map<string, .v1.MatchString> labels = 8;
boolean	containsSubset(String key) 可选，SUBSET标识 map<string, .v1.MatchString> subset = 4;
com.google.protobuf.StringValue	getAction() 限流动作，对应着客户端的插件名字 .google.protobuf.StringValue action = 10;
com.google.protobuf.StringValueOrBuilder	getActionOrBuilder() 限流动作，对应着客户端的插件名字 .google.protobuf.StringValue action = 10;
RateLimitProto.AmountAdjuster	getAdjuster() 配额调整算法 .v1.AmountAdjuster adjuster = 17;
RateLimitProto.AmountAdjusterOrBuilder	getAdjusterOrBuilder() 配额调整算法 .v1.AmountAdjuster adjuster = 17;
RateLimitProto.Rule.AmountMode	getAmountMode() .v1.Rule.AmountMode amount_mode = 19;
int	getAmountModeValue() .v1.Rule.AmountMode amount_mode = 19;
RateLimitProto.Amount	getAmounts(int index) 限流阈值 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量 repeated .v1.Amount amounts = 9;
int	getAmountsCount() 限流阈值 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量 repeated .v1.Amount amounts = 9;
List<RateLimitProto.Amount>	getAmountsList() 限流阈值 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量 repeated .v1.Amount amounts = 9;
RateLimitProto.AmountOrBuilder	getAmountsOrBuilder(int index) 限流阈值 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量 repeated .v1.Amount amounts = 9;
List<? extends RateLimitProto.AmountOrBuilder>	getAmountsOrBuilderList() 限流阈值 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量 repeated .v1.Amount amounts = 9;
RateLimitProto.RateLimitCluster	getCluster() 分布式限流服务集群 .v1.RateLimitCluster cluster = 21;
RateLimitProto.RateLimitClusterOrBuilder	getClusterOrBuilder() 分布式限流服务集群 .v1.RateLimitCluster cluster = 21;
com.google.protobuf.StringValue	getCtime() 限流规则创建时间 .google.protobuf.StringValue ctime = 13;
com.google.protobuf.StringValueOrBuilder	getCtimeOrBuilder() 限流规则创建时间 .google.protobuf.StringValue ctime = 13;
com.google.protobuf.BoolValue	getDisable() 是否停用该限流规则，默认启用 .google.protobuf.BoolValue disable = 11;
com.google.protobuf.BoolValueOrBuilder	getDisableOrBuilder() 是否停用该限流规则，默认启用 .google.protobuf.BoolValue disable = 11;
RateLimitProto.Rule.FailoverType	getFailover() .v1.Rule.FailoverType failover = 20;
int	getFailoverValue() .v1.Rule.FailoverType failover = 20;
com.google.protobuf.StringValue	getId() 限流规则唯一标识 .google.protobuf.StringValue id = 1;
com.google.protobuf.StringValueOrBuilder	getIdOrBuilder() 限流规则唯一标识 .google.protobuf.StringValue id = 1;
Map<String,ModelProto.MatchString>	getLabels() 已过时。
int	getLabelsCount() 业务标签集合，通过KV进行匹配，全部匹配才使用该规则 map<string, .v1.MatchString> labels = 8;
Map<String,ModelProto.MatchString>	getLabelsMap() 业务标签集合，通过KV进行匹配，全部匹配才使用该规则 map<string, .v1.MatchString> labels = 8;
ModelProto.MatchString	getLabelsOrDefault(String key, ModelProto.MatchString defaultValue) 业务标签集合，通过KV进行匹配，全部匹配才使用该规则 map<string, .v1.MatchString> labels = 8;
ModelProto.MatchString	getLabelsOrThrow(String key) 业务标签集合，通过KV进行匹配，全部匹配才使用该规则 map<string, .v1.MatchString> labels = 8;
com.google.protobuf.StringValue	getMtime() 限流规则修改时间 .google.protobuf.StringValue mtime = 14;
com.google.protobuf.StringValueOrBuilder	getMtimeOrBuilder() 限流规则修改时间 .google.protobuf.StringValue mtime = 14;
com.google.protobuf.StringValue	getNamespace() 限流规则所属命名空间 .google.protobuf.StringValue namespace = 3;
com.google.protobuf.StringValueOrBuilder	getNamespaceOrBuilder() 限流规则所属命名空间 .google.protobuf.StringValue namespace = 3;
com.google.protobuf.UInt32Value	getPriority() 限流规则优先级，0值最高 .google.protobuf.UInt32Value priority = 5;
com.google.protobuf.UInt32ValueOrBuilder	getPriorityOrBuilder() 限流规则优先级，0值最高 .google.protobuf.UInt32Value priority = 5;
com.google.protobuf.BoolValue	getRegexCombine() 通配符是否合并计算，默认分开计数 .google.protobuf.BoolValue regex_combine = 18;
com.google.protobuf.BoolValueOrBuilder	getRegexCombineOrBuilder() 通配符是否合并计算，默认分开计数 .google.protobuf.BoolValue regex_combine = 18;
RateLimitProto.Report	getReport() 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报 .v1.Report report = 12;
RateLimitProto.ReportOrBuilder	getReportOrBuilder() 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报 .v1.Report report = 12;
RateLimitProto.Rule.Resource	getResource() .v1.Rule.Resource resource = 6;
int	getResourceValue() .v1.Rule.Resource resource = 6;
com.google.protobuf.StringValue	getRevision() 限流规则revision信息 .google.protobuf.StringValue revision = 15;
com.google.protobuf.StringValueOrBuilder	getRevisionOrBuilder() 限流规则revision信息 .google.protobuf.StringValue revision = 15;
com.google.protobuf.StringValue	getService() 限流规则所属服务名 .google.protobuf.StringValue service = 2;
com.google.protobuf.StringValueOrBuilder	getServiceOrBuilder() 限流规则所属服务名 .google.protobuf.StringValue service = 2;
com.google.protobuf.StringValue	getServiceToken() 服务的TOKEN信息，仅用于控制台，discover接口不下发 .google.protobuf.StringValue service_token = 16[json_name = "service_token"];
com.google.protobuf.StringValueOrBuilder	getServiceTokenOrBuilder() 服务的TOKEN信息，仅用于控制台，discover接口不下发 .google.protobuf.StringValue service_token = 16[json_name = "service_token"];
Map<String,ModelProto.MatchString>	getSubset() 已过时。
int	getSubsetCount() 可选，SUBSET标识 map<string, .v1.MatchString> subset = 4;
Map<String,ModelProto.MatchString>	getSubsetMap() 可选，SUBSET标识 map<string, .v1.MatchString> subset = 4;
ModelProto.MatchString	getSubsetOrDefault(String key, ModelProto.MatchString defaultValue) 可选，SUBSET标识 map<string, .v1.MatchString> subset = 4;
ModelProto.MatchString	getSubsetOrThrow(String key) 可选，SUBSET标识 map<string, .v1.MatchString> subset = 4;
RateLimitProto.Rule.Type	getType() .v1.Rule.Type type = 7;
int	getTypeValue() .v1.Rule.Type type = 7;
boolean	hasAction() 限流动作，对应着客户端的插件名字 .google.protobuf.StringValue action = 10;
boolean	hasAdjuster() 配额调整算法 .v1.AmountAdjuster adjuster = 17;
boolean	hasCluster() 分布式限流服务集群 .v1.RateLimitCluster cluster = 21;
boolean	hasCtime() 限流规则创建时间 .google.protobuf.StringValue ctime = 13;
boolean	hasDisable() 是否停用该限流规则，默认启用 .google.protobuf.BoolValue disable = 11;
boolean	hasId() 限流规则唯一标识 .google.protobuf.StringValue id = 1;
boolean	hasMtime() 限流规则修改时间 .google.protobuf.StringValue mtime = 14;
boolean	hasNamespace() 限流规则所属命名空间 .google.protobuf.StringValue namespace = 3;
boolean	hasPriority() 限流规则优先级，0值最高 .google.protobuf.UInt32Value priority = 5;
boolean	hasRegexCombine() 通配符是否合并计算，默认分开计数 .google.protobuf.BoolValue regex_combine = 18;
boolean	hasReport() 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报 .v1.Report report = 12;
boolean	hasRevision() 限流规则revision信息 .google.protobuf.StringValue revision = 15;
boolean	hasService() 限流规则所属服务名 .google.protobuf.StringValue service = 2;
boolean	hasServiceToken() 服务的TOKEN信息，仅用于控制台，discover接口不下发 .google.protobuf.StringValue service_token = 16[json_name = "service_token"];

从接口继承的方法 com.google.protobuf.MessageOrBuilder

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

从接口继承的方法 com.google.protobuf.MessageLiteOrBuilder

isInitialized

方法详细资料

hasId

boolean hasId()

 限流规则唯一标识
 

.google.protobuf.StringValue id = 1;

返回:

Whether the id field is set.

getId

com.google.protobuf.StringValue getId()

 限流规则唯一标识
 

.google.protobuf.StringValue id = 1;

返回:

The id.

getIdOrBuilder

com.google.protobuf.StringValueOrBuilder getIdOrBuilder()

 限流规则唯一标识
 

.google.protobuf.StringValue id = 1;

hasService

boolean hasService()

 限流规则所属服务名
 

.google.protobuf.StringValue service = 2;

返回:

Whether the service field is set.

getService

com.google.protobuf.StringValue getService()

 限流规则所属服务名
 

.google.protobuf.StringValue service = 2;

返回:

The service.

getServiceOrBuilder

com.google.protobuf.StringValueOrBuilder getServiceOrBuilder()

 限流规则所属服务名
 

.google.protobuf.StringValue service = 2;

hasNamespace

boolean hasNamespace()

 限流规则所属命名空间
 

.google.protobuf.StringValue namespace = 3;

返回:

Whether the namespace field is set.

getNamespace

com.google.protobuf.StringValue getNamespace()

 限流规则所属命名空间
 

.google.protobuf.StringValue namespace = 3;

返回:

The namespace.

getNamespaceOrBuilder

com.google.protobuf.StringValueOrBuilder getNamespaceOrBuilder()

 限流规则所属命名空间
 

.google.protobuf.StringValue namespace = 3;

getSubsetCount

int getSubsetCount()

 可选，SUBSET标识
 

map<string, .v1.MatchString> subset = 4;

containsSubset

boolean containsSubset(String key)

 可选，SUBSET标识
 

map<string, .v1.MatchString> subset = 4;

getSubset

@Deprecated
Map<String,ModelProto.MatchString> getSubset()

已过时。

Use getSubsetMap() instead.

getSubsetMap

Map<String,ModelProto.MatchString> getSubsetMap()

 可选，SUBSET标识
 

map<string, .v1.MatchString> subset = 4;

getSubsetOrDefault

ModelProto.MatchString getSubsetOrDefault(String key,
                                          ModelProto.MatchString defaultValue)

 可选，SUBSET标识
 

map<string, .v1.MatchString> subset = 4;

getSubsetOrThrow

ModelProto.MatchString getSubsetOrThrow(String key)

 可选，SUBSET标识
 

map<string, .v1.MatchString> subset = 4;

hasPriority

boolean hasPriority()

 限流规则优先级，0值最高
 

.google.protobuf.UInt32Value priority = 5;

返回:

Whether the priority field is set.

getPriority

com.google.protobuf.UInt32Value getPriority()

 限流规则优先级，0值最高
 

.google.protobuf.UInt32Value priority = 5;

返回:

The priority.

getPriorityOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getPriorityOrBuilder()

 限流规则优先级，0值最高
 

.google.protobuf.UInt32Value priority = 5;

getResourceValue

int getResourceValue()

.v1.Rule.Resource resource = 6;

返回:

The enum numeric value on the wire for resource.

getResource

RateLimitProto.Rule.Resource getResource()

.v1.Rule.Resource resource = 6;

返回:

The resource.

getTypeValue

int getTypeValue()

.v1.Rule.Type type = 7;

返回:

The enum numeric value on the wire for type.

getType

RateLimitProto.Rule.Type getType()

.v1.Rule.Type type = 7;

返回:

The type.

getLabelsCount

int getLabelsCount()

 业务标签集合，通过KV进行匹配，全部匹配才使用该规则
 

map<string, .v1.MatchString> labels = 8;

containsLabels

boolean containsLabels(String key)

 业务标签集合，通过KV进行匹配，全部匹配才使用该规则
 

map<string, .v1.MatchString> labels = 8;

getLabels

@Deprecated
Map<String,ModelProto.MatchString> getLabels()

已过时。

Use getLabelsMap() instead.

getLabelsMap

Map<String,ModelProto.MatchString> getLabelsMap()

 业务标签集合，通过KV进行匹配，全部匹配才使用该规则
 

map<string, .v1.MatchString> labels = 8;

getLabelsOrDefault

ModelProto.MatchString getLabelsOrDefault(String key,
                                          ModelProto.MatchString defaultValue)

 业务标签集合，通过KV进行匹配，全部匹配才使用该规则
 

map<string, .v1.MatchString> labels = 8;

getLabelsOrThrow

ModelProto.MatchString getLabelsOrThrow(String key)

 业务标签集合，通过KV进行匹配，全部匹配才使用该规则
 

map<string, .v1.MatchString> labels = 8;

getAmountsList

List<RateLimitProto.Amount> getAmountsList()

 限流阈值
 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流
 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量
 

repeated .v1.Amount amounts = 9;

getAmounts

RateLimitProto.Amount getAmounts(int index)

 限流阈值
 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流
 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量
 

repeated .v1.Amount amounts = 9;

getAmountsCount

int getAmountsCount()

 限流阈值
 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流
 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量
 

repeated .v1.Amount amounts = 9;

getAmountsOrBuilderList

List<? extends RateLimitProto.AmountOrBuilder> getAmountsOrBuilderList()

 限流阈值
 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流
 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量
 

repeated .v1.Amount amounts = 9;

getAmountsOrBuilder

RateLimitProto.AmountOrBuilder getAmountsOrBuilder(int index)

 限流阈值
 可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流
 全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量
 

repeated .v1.Amount amounts = 9;

hasAction

boolean hasAction()

 限流动作，对应着客户端的插件名字
 

.google.protobuf.StringValue action = 10;

返回:

Whether the action field is set.

getAction

com.google.protobuf.StringValue getAction()

 限流动作，对应着客户端的插件名字
 

.google.protobuf.StringValue action = 10;

返回:

The action.

getActionOrBuilder

com.google.protobuf.StringValueOrBuilder getActionOrBuilder()

 限流动作，对应着客户端的插件名字
 

.google.protobuf.StringValue action = 10;

hasDisable

boolean hasDisable()

 是否停用该限流规则，默认启用
 

.google.protobuf.BoolValue disable = 11;

返回:

Whether the disable field is set.

getDisable

com.google.protobuf.BoolValue getDisable()

 是否停用该限流规则，默认启用
 

.google.protobuf.BoolValue disable = 11;

返回:

The disable.

getDisableOrBuilder

com.google.protobuf.BoolValueOrBuilder getDisableOrBuilder()

 是否停用该限流规则，默认启用
 

.google.protobuf.BoolValue disable = 11;

hasReport

boolean hasReport()

 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
 

.v1.Report report = 12;

返回:

Whether the report field is set.

getReport

RateLimitProto.Report getReport()

 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
 

.v1.Report report = 12;

返回:

The report.

getReportOrBuilder

RateLimitProto.ReportOrBuilder getReportOrBuilder()

 限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
 

.v1.Report report = 12;

hasCtime

boolean hasCtime()

 限流规则创建时间
 

.google.protobuf.StringValue ctime = 13;

返回:

Whether the ctime field is set.

getCtime

com.google.protobuf.StringValue getCtime()

 限流规则创建时间
 

.google.protobuf.StringValue ctime = 13;

返回:

The ctime.

getCtimeOrBuilder

com.google.protobuf.StringValueOrBuilder getCtimeOrBuilder()

 限流规则创建时间
 

.google.protobuf.StringValue ctime = 13;

hasMtime

boolean hasMtime()

 限流规则修改时间
 

.google.protobuf.StringValue mtime = 14;

返回:

Whether the mtime field is set.

getMtime

com.google.protobuf.StringValue getMtime()

 限流规则修改时间
 

.google.protobuf.StringValue mtime = 14;

返回:

The mtime.

getMtimeOrBuilder

com.google.protobuf.StringValueOrBuilder getMtimeOrBuilder()

 限流规则修改时间
 

.google.protobuf.StringValue mtime = 14;

hasRevision

boolean hasRevision()

 限流规则revision信息
 

.google.protobuf.StringValue revision = 15;

返回:

Whether the revision field is set.

getRevision

com.google.protobuf.StringValue getRevision()

 限流规则revision信息
 

.google.protobuf.StringValue revision = 15;

返回:

The revision.

getRevisionOrBuilder

com.google.protobuf.StringValueOrBuilder getRevisionOrBuilder()

 限流规则revision信息
 

.google.protobuf.StringValue revision = 15;

hasServiceToken

boolean hasServiceToken()

 服务的TOKEN信息，仅用于控制台，discover接口不下发
 

.google.protobuf.StringValue service_token = 16[json_name = "service_token"];

返回:

Whether the serviceToken field is set.

getServiceToken

com.google.protobuf.StringValue getServiceToken()

 服务的TOKEN信息，仅用于控制台，discover接口不下发
 

.google.protobuf.StringValue service_token = 16[json_name = "service_token"];

返回:

The serviceToken.

getServiceTokenOrBuilder

com.google.protobuf.StringValueOrBuilder getServiceTokenOrBuilder()

 服务的TOKEN信息，仅用于控制台，discover接口不下发
 

.google.protobuf.StringValue service_token = 16[json_name = "service_token"];

hasAdjuster

boolean hasAdjuster()

 配额调整算法
 

.v1.AmountAdjuster adjuster = 17;

返回:

Whether the adjuster field is set.

getAdjuster

RateLimitProto.AmountAdjuster getAdjuster()

 配额调整算法
 

.v1.AmountAdjuster adjuster = 17;

返回:

The adjuster.

getAdjusterOrBuilder

RateLimitProto.AmountAdjusterOrBuilder getAdjusterOrBuilder()

 配额调整算法
 

.v1.AmountAdjuster adjuster = 17;

hasRegexCombine

boolean hasRegexCombine()

 通配符是否合并计算，默认分开计数
 

.google.protobuf.BoolValue regex_combine = 18;

返回:

Whether the regexCombine field is set.

getRegexCombine

com.google.protobuf.BoolValue getRegexCombine()

 通配符是否合并计算，默认分开计数
 

.google.protobuf.BoolValue regex_combine = 18;

返回:

The regexCombine.

getRegexCombineOrBuilder

com.google.protobuf.BoolValueOrBuilder getRegexCombineOrBuilder()

 通配符是否合并计算，默认分开计数
 

.google.protobuf.BoolValue regex_combine = 18;

getAmountModeValue

int getAmountModeValue()

.v1.Rule.AmountMode amount_mode = 19;

返回:

The enum numeric value on the wire for amountMode.

getAmountMode

RateLimitProto.Rule.AmountMode getAmountMode()

.v1.Rule.AmountMode amount_mode = 19;

返回:

The amountMode.

getFailoverValue

int getFailoverValue()

.v1.Rule.FailoverType failover = 20;

返回:

The enum numeric value on the wire for failover.

getFailover

RateLimitProto.Rule.FailoverType getFailover()

.v1.Rule.FailoverType failover = 20;

返回:

The failover.

hasCluster

boolean hasCluster()

 分布式限流服务集群
 

.v1.RateLimitCluster cluster = 21;

返回:

Whether the cluster field is set.

getCluster

RateLimitProto.RateLimitCluster getCluster()

 分布式限流服务集群
 

.v1.RateLimitCluster cluster = 21;

返回:

The cluster.

getClusterOrBuilder

RateLimitProto.RateLimitClusterOrBuilder getClusterOrBuilder()

 分布式限流服务集群
 

.v1.RateLimitCluster cluster = 21;