Class: Google::Cloud::ServiceControl::V1::QuotaError

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/servicecontrol/v1/quota_controller.rb

Overview

Represents error information for QuotaOperation.

Defined Under Namespace

Modules: Code

Instance Attribute Summary collapse

Instance Attribute Details

#code::Google::Cloud::ServiceControl::V1::QuotaError::Code

Returns Error code.



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
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 198

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

  # Error codes related to project config validations are deprecated since the
  # quota controller methods do not perform these validations. Instead services
  # have to call the Check method, without quota_properties field, to perform
  # these validations before calling the quota controller methods. These
  # methods check only for project deletion to be wipe out compliant.
  module Code
    # This is never used.
    UNSPECIFIED = 0

    # Quota allocation failed.
    # Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
    RESOURCE_EXHAUSTED = 8

    # Consumer cannot access the service because the service requires active
    # billing.
    BILLING_NOT_ACTIVE = 107

    # Consumer's project has been marked as deleted (soft deletion).
    PROJECT_DELETED = 108

    # Specified API key is invalid.
    API_KEY_INVALID = 105

    # Specified API Key has expired.
    API_KEY_EXPIRED = 112
  end
end

#description::String

Returns Free-form text that provides details on the cause of the error.

Returns:

  • (::String)

    Free-form text that provides details on the cause of the error.



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
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 198

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

  # Error codes related to project config validations are deprecated since the
  # quota controller methods do not perform these validations. Instead services
  # have to call the Check method, without quota_properties field, to perform
  # these validations before calling the quota controller methods. These
  # methods check only for project deletion to be wipe out compliant.
  module Code
    # This is never used.
    UNSPECIFIED = 0

    # Quota allocation failed.
    # Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
    RESOURCE_EXHAUSTED = 8

    # Consumer cannot access the service because the service requires active
    # billing.
    BILLING_NOT_ACTIVE = 107

    # Consumer's project has been marked as deleted (soft deletion).
    PROJECT_DELETED = 108

    # Specified API key is invalid.
    API_KEY_INVALID = 105

    # Specified API Key has expired.
    API_KEY_EXPIRED = 112
  end
end

#status::Google::Rpc::Status

Returns Contains additional information about the quota error. If available, status.code will be non zero.

Returns:

  • (::Google::Rpc::Status)

    Contains additional information about the quota error. If available, status.code will be non zero.



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
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 198

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

  # Error codes related to project config validations are deprecated since the
  # quota controller methods do not perform these validations. Instead services
  # have to call the Check method, without quota_properties field, to perform
  # these validations before calling the quota controller methods. These
  # methods check only for project deletion to be wipe out compliant.
  module Code
    # This is never used.
    UNSPECIFIED = 0

    # Quota allocation failed.
    # Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
    RESOURCE_EXHAUSTED = 8

    # Consumer cannot access the service because the service requires active
    # billing.
    BILLING_NOT_ACTIVE = 107

    # Consumer's project has been marked as deleted (soft deletion).
    PROJECT_DELETED = 108

    # Specified API key is invalid.
    API_KEY_INVALID = 105

    # Specified API Key has expired.
    API_KEY_EXPIRED = 112
  end
end

#subject::String

Returns Subject to whom this error applies. See the specific enum for more details on this field. For example, "clientip:" or "project:".

Returns:

  • (::String)

    Subject to whom this error applies. See the specific enum for more details on this field. For example, "clientip:" or "project:".



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
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 198

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

  # Error codes related to project config validations are deprecated since the
  # quota controller methods do not perform these validations. Instead services
  # have to call the Check method, without quota_properties field, to perform
  # these validations before calling the quota controller methods. These
  # methods check only for project deletion to be wipe out compliant.
  module Code
    # This is never used.
    UNSPECIFIED = 0

    # Quota allocation failed.
    # Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
    RESOURCE_EXHAUSTED = 8

    # Consumer cannot access the service because the service requires active
    # billing.
    BILLING_NOT_ACTIVE = 107

    # Consumer's project has been marked as deleted (soft deletion).
    PROJECT_DELETED = 108

    # Specified API key is invalid.
    API_KEY_INVALID = 105

    # Specified API Key has expired.
    API_KEY_EXPIRED = 112
  end
end