Reference documentation and code samples for the Service Usage V1 API class Google::Api::QuotaLimit.
QuotaLimit defines a specific limit that applies over a specified duration
for a limit type. There can be at most one limit for a duration and limit
type combination defined within a QuotaGroup.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#default_limit
def default_limit() -> ::Integer-
(::Integer) — 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.
#default_limit=
def default_limit=(value) -> ::Integer-
value (::Integer) — 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.
-
(::Integer) — 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.
#description
def description() -> ::String-
(::String) — 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).
#description=
def description=(value) -> ::String-
value (::String) — 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) — 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).
#display_name
def display_name() -> ::String- (::String) — 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.
#display_name=
def display_name=(value) -> ::String- value (::String) — 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) — 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.
#duration
def duration() -> ::String-
(::String) — Duration of this limit in textual notation. Must be "100s" or "1d".
Used by group-based quotas only.
#duration=
def duration=(value) -> ::String-
value (::String) — Duration of this limit in textual notation. Must be "100s" or "1d".
Used by group-based quotas only.
-
(::String) — Duration of this limit in textual notation. Must be "100s" or "1d".
Used by group-based quotas only.
#free_tier
def free_tier() -> ::Integer-
(::Integer) — 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.
#free_tier=
def free_tier=(value) -> ::Integer-
value (::Integer) — 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.
-
(::Integer) — 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.
#max_limit
def max_limit() -> ::Integer-
(::Integer) — 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.
#max_limit=
def max_limit=(value) -> ::Integer-
value (::Integer) — 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.
-
(::Integer) — 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.
#metric
def metric() -> ::String- (::String) — 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.
#metric=
def metric=(value) -> ::String- value (::String) — 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) — 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.
#name
def name() -> ::String-
(::String) — 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.
#name=
def name=(value) -> ::String-
value (::String) — 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 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.
#unit
def unit() -> ::String-
(::String) — Specify the unit of the quota limit. It uses the same syntax as
[MetricDescriptor.unit][google.api.MetricDescriptor.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.
#unit=
def unit=(value) -> ::String-
value (::String) — Specify the unit of the quota limit. It uses the same syntax as
[MetricDescriptor.unit][google.api.MetricDescriptor.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) — Specify the unit of the quota limit. It uses the same syntax as
[MetricDescriptor.unit][google.api.MetricDescriptor.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.
#values
def values() -> ::Google::Protobuf::Map{::String => ::Integer}- (::Google::Protobuf::Map{::String => ::Integer}) — 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.
#values=
def values=(value) -> ::Google::Protobuf::Map{::String => ::Integer}- value (::Google::Protobuf::Map{::String => ::Integer}) — 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.
- (::Google::Protobuf::Map{::String => ::Integer}) — 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.