public interface QuotaLimitOrBuilder extends MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsValues(java.lang.String key)
Tiered limit values.
|
long |
getDefaultLimit()
Default number of tokens that can be consumed during the specified
duration.
|
java.lang.String |
getDescription()
Optional.
|
ByteString |
getDescriptionBytes()
Optional.
|
java.lang.String |
getDisplayName()
User-visible display name for this limit.
|
ByteString |
getDisplayNameBytes()
User-visible display name for this limit.
|
java.lang.String |
getDuration()
Duration of this limit in textual notation.
|
ByteString |
getDurationBytes()
Duration of this limit in textual notation.
|
long |
getFreeTier()
Free tier value displayed in the Developers Console for this limit.
|
long |
getMaxLimit()
Maximum number of tokens that can be consumed during the specified
duration.
|
java.lang.String |
getMetric()
The name of the metric this quota limit applies to.
|
ByteString |
getMetricBytes()
The name of the metric this quota limit applies to.
|
java.lang.String |
getName()
Name of the quota limit.
|
ByteString |
getNameBytes()
Name of the quota limit.
|
java.lang.String |
getUnit()
Specify the unit of the quota limit.
|
ByteString |
getUnitBytes()
Specify the unit of the quota limit.
|
java.util.Map<java.lang.String,java.lang.Long> |
getValues()
Deprecated.
|
int |
getValuesCount()
Tiered limit values.
|
java.util.Map<java.lang.String,java.lang.Long> |
getValuesMap()
Tiered limit values.
|
long |
getValuesOrDefault(java.lang.String key,
long defaultValue)
Tiered limit values.
|
long |
getValuesOrThrow(java.lang.String key)
Tiered limit values.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofisInitializedjava.lang.String getName()
Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
string name = 6;ByteString getNameBytes()
Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
string name = 6;java.lang.String getDescription()
Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
string description = 2;ByteString getDescriptionBytes()
Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).
string description = 2;long getDefaultLimit()
Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
int64 default_limit = 3;long getMaxLimit()
Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
int64 max_limit = 4;long getFreeTier()
Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
int64 free_tier = 7;java.lang.String getDuration()
Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only.
string duration = 5;ByteString getDurationBytes()
Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only.
string duration = 5;java.lang.String getMetric()
The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
string metric = 8;ByteString getMetricBytes()
The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
string metric = 8;java.lang.String getUnit()
Specify the unit of the quota limit. It uses the same syntax as
[Metric.unit][]. The supported unit kinds are determined by the quota
backend system.
Here are some examples:
* "1/min/{project}" for quota per minute per project.
Note: the order of unit components is insignificant.
The "1" at the beginning is required to follow the metric unit syntax.
string unit = 9;ByteString getUnitBytes()
Specify the unit of the quota limit. It uses the same syntax as
[Metric.unit][]. The supported unit kinds are determined by the quota
backend system.
Here are some examples:
* "1/min/{project}" for quota per minute per project.
Note: the order of unit components is insignificant.
The "1" at the beginning is required to follow the metric unit syntax.
string unit = 9;int getValuesCount()
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;boolean containsValues(java.lang.String key)
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;@Deprecated java.util.Map<java.lang.String,java.lang.Long> getValues()
getValuesMap() instead.java.util.Map<java.lang.String,java.lang.Long> getValuesMap()
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;long getValuesOrDefault(java.lang.String key,
long defaultValue)
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;long getValuesOrThrow(java.lang.String key)
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;java.lang.String getDisplayName()
User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
string display_name = 12;ByteString getDisplayNameBytes()
User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
string display_name = 12;