Class: Google::Apis::ServicecontrolV1::QuotaInfo
- Inherits:
-
Object
- Object
- Google::Apis::ServicecontrolV1::QuotaInfo
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/representations.rb
Overview
Contains the quota information for a quota check response.
Instance Attribute Summary collapse
-
#limit_exceeded ⇒ Array<String>
Quota Metrics that have exceeded quota limits.
-
#quota_consumed ⇒ Hash<String,Fixnum>
Map of quota group name to the actual number of tokens consumed.
-
#quota_metrics ⇒ Array<Google::Apis::ServicecontrolV1::MetricValueSet>
Quota metrics to indicate the usage.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QuotaInfo
constructor
A new instance of QuotaInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ QuotaInfo
Returns a new instance of QuotaInfo.
1698 1699 1700 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1698 def initialize(**args) update!(**args) end |
Instance Attribute Details
#limit_exceeded ⇒ Array<String>
Quota Metrics that have exceeded quota limits.
For QuotaGroup-based quota, this is QuotaGroup.name
For QuotaLimit-based quota, this is QuotaLimit.name
See: google.api.Quota
Deprecated: Use quota_metrics to get per quota group limit exceeded status.
Corresponds to the JSON property limitExceeded
1670 1671 1672 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1670 def limit_exceeded @limit_exceeded end |
#quota_consumed ⇒ Hash<String,Fixnum>
Map of quota group name to the actual number of tokens consumed. If the
quota check was not successful, then this will not be populated due to no
quota consumption.
We are not merging this field with 'quota_metrics' field because of the
complexity of scaling in Chemist client code base. For simplicity, we will
keep this field for Castor (that scales quota usage) and 'quota_metrics'
for SuperQuota (that doesn't scale quota usage).
Corresponds to the JSON property quotaConsumed
1681 1682 1683 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1681 def quota_consumed @quota_consumed end |
#quota_metrics ⇒ Array<Google::Apis::ServicecontrolV1::MetricValueSet>
Quota metrics to indicate the usage. Depending on the check request, one or more of the following metrics will be included:
- For rate quota, per quota group or per quota metric incremental usage will be specified using the following delta metric: "serviceruntime.googleapis.com/api/consumer/quota_used_count"
- For allocation quota, per quota metric total usage will be specified using the following gauge metric: "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
- For both rate quota and allocation quota, the quota limit reached
condition will be specified using the following boolean metric:
"serviceruntime.googleapis.com/quota/exceeded"
Corresponds to the JSON property
quotaMetrics
1696 1697 1698 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1696 def quota_metrics @quota_metrics end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1703 1704 1705 1706 1707 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1703 def update!(**args) @limit_exceeded = args[:limit_exceeded] if args.key?(:limit_exceeded) @quota_consumed = args[:quota_consumed] if args.key?(:quota_consumed) @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) end |