Class: Google::Apis::ServiceconsumermanagementV1::QuotaLimit
- Inherits:
-
Object
- Object
- Google::Apis::ServiceconsumermanagementV1::QuotaLimit
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceconsumermanagement_v1/classes.rb,
generated/google/apis/serviceconsumermanagement_v1/representations.rb,
generated/google/apis/serviceconsumermanagement_v1/representations.rb
Overview
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
.
Instance Attribute Summary collapse
-
#default_limit ⇒ Fixnum
Default number of tokens that can be consumed during the specified duration.
-
#description ⇒ String
Optional.
-
#display_name ⇒ String
User-visible display name for this limit.
-
#duration ⇒ String
Duration of this limit in textual notation.
-
#free_tier ⇒ Fixnum
Free tier value displayed in the Developers Console for this limit.
-
#max_limit ⇒ Fixnum
Maximum number of tokens that can be consumed during the specified duration.
-
#metric ⇒ String
The name of the metric this quota limit applies to.
-
#name ⇒ String
Name of the quota limit.
-
#unit ⇒ String
Specify the unit of the quota limit.
-
#values ⇒ Hash<String,Fixnum>
Tiered limit values.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QuotaLimit
constructor
A new instance of QuotaLimit.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ QuotaLimit
Returns a new instance of QuotaLimit
2818 2819 2820 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2818 def initialize(**args) update!(**args) end |
Instance Attribute Details
#default_limit ⇒ Fixnum
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.
Corresponds to the JSON property defaultLimit
2737 2738 2739 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2737 def default_limit @default_limit end |
#description ⇒ 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
).
Corresponds to the JSON property description
2744 2745 2746 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2744 def description @description end |
#display_name ⇒ 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.
Corresponds to the JSON property displayName
2752 2753 2754 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2752 def display_name @display_name end |
#duration ⇒ String
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.
Corresponds to the JSON property duration
2761 2762 2763 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2761 def duration @duration end |
#free_tier ⇒ Fixnum
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.
Corresponds to the JSON property freeTier
2772 2773 2774 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2772 def free_tier @free_tier end |
#max_limit ⇒ Fixnum
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.
Corresponds to the JSON property maxLimit
2783 2784 2785 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2783 def max_limit @max_limit end |
#metric ⇒ 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.
Corresponds to the JSON property metric
2790 2791 2792 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2790 def metric @metric end |
#name ⇒ 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.
Corresponds to the JSON property name
2798 2799 2800 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2798 def name @name end |
#unit ⇒ String
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. Corresponds to the JSON propertyunit
2809 2810 2811 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2809 def unit @unit end |
#values ⇒ Hash<String,Fixnum>
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.
Corresponds to the JSON property values
2816 2817 2818 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2816 def values @values end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 |
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2823 def update!(**args) @default_limit = args[:default_limit] if args.key?(:default_limit) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @duration = args[:duration] if args.key?(:duration) @free_tier = args[:free_tier] if args.key?(:free_tier) @max_limit = args[:max_limit] if args.key?(:max_limit) @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @unit = args[:unit] if args.key?(:unit) @values = args[:values] if args.key?(:values) end |