Class: Google::Rpc::QuotaFailure

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/rpc/error_details.rb

Overview

Describes how a quota check failed.

For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

Also see RetryInfo and Help types for other details about handling a quota failure.

Defined Under Namespace

Classes: Violation

Instance Attribute Summary collapse

Instance Attribute Details

#violations ⇒ ::Array<::Google::Rpc::QuotaFailure::Violation>

Returns Describes all quota violations.

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/rpc/error_details.rb', line 133

class QuotaFailure
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message type used to describe a single quota violation.  For example, a
  # daily quota or a custom quota that was exceeded.
  # @!attribute [rw] subject
  #   @return [::String]
  #     The subject on which the quota check failed.
  #     For example, "clientip:<ip address of client>" or "project:<Google
  #     developer project id>".
  # @!attribute [rw] description
  #   @return [::String]
  #     A description of how the quota check failed. Clients can use this
  #     description to find more about the quota configuration in the service's
  #     public documentation, or find the relevant quota limit to adjust through
  #     developer console.
  #
  #     For example: "Service disabled" or "Daily Limit for read operations
  #     exceeded".
  # @!attribute [rw] api_service
  #   @return [::String]
  #     The API Service from which the `QuotaFailure.Violation` orginates. In
  #     some cases, Quota issues originate from an API Service other than the one
  #     that was called. In other words, a dependency of the called API Service
  #     could be the cause of the `QuotaFailure`, and this field would have the
  #     dependency API service name.
  #
  #     For example, if the called API is Kubernetes Engine API
  #     (container.googleapis.com), and a quota violation occurs in the
  #     Kubernetes Engine API itself, this field would be
  #     "container.googleapis.com". On the other hand, if the quota violation
  #     occurs when the Kubernetes Engine API creates VMs in the Compute Engine
  #     API (compute.googleapis.com), this field would be
  #     "compute.googleapis.com".
  # @!attribute [rw] quota_metric
  #   @return [::String]
  #     The metric of the violated quota. A quota metric is a named counter to
  #     measure usage, such as API requests or CPUs. When an activity occurs in a
  #     service, such as Virtual Machine allocation, one or more quota metrics
  #     may be affected.
  #
  #     For example, "compute.googleapis.com/cpus_per_vm_family",
  #     "storage.googleapis.com/internet_egress_bandwidth".
  # @!attribute [rw] quota_id
  #   @return [::String]
  #     The id of the violated quota. Also know as "limit name", this is the
  #     unique identifier of a quota in the context of an API service.
  #
  #     For example, "CPUS-PER-VM-FAMILY-per-project-region".
  # @!attribute [rw] quota_dimensions
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     The dimensions of the violated quota. Every non-global quota is enforced
  #     on a set of dimensions. While quota metric defines what to count, the
  #     dimensions specify for what aspects the counter should be increased.
  #
  #     For example, the quota "CPUs per region per VM family" enforces a limit
  #     on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions
  #     "region" and "vm_family". And if the violation occurred in region
  #     "us-central1" and for VM family "n1", the quota_dimensions would be,
  #
  #     {
  #       "region": "us-central1",
  #       "vm_family": "n1",
  #     }
  #
  #     When a quota is enforced globally, the quota_dimensions would always be
  #     empty.
  # @!attribute [rw] quota_value
  #   @return [::Integer]
  #     The enforced quota value at the time of the `QuotaFailure`.
  #
  #     For example, if the enforced quota value at the time of the
  #     `QuotaFailure` on the number of CPUs is "10", then the value of this
  #     field would reflect this quantity.
  # @!attribute [rw] future_quota_value
  #   @return [::Integer]
  #     The new quota value being rolled out at the time of the violation. At the
  #     completion of the rollout, this value will be enforced in place of
  #     quota_value. If no rollout is in progress at the time of the violation,
  #     this field is not set.
  #
  #     For example, if at the time of the violation a rollout is in progress
  #     changing the number of CPUs quota from 10 to 20, 20 would be the value of
  #     this field.
  class Violation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class QuotaDimensionsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end