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:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'proto_docs/google/rpc/error_details.rb', line 132

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".
  class Violation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end