Class QuotaFailureViolation

A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

Inheritance
object
QuotaFailureViolation
Implements
Inherited Members
Namespace: Google.Apis.DatabaseMigrationService.v1.Data
Assembly: Google.Apis.DatabaseMigrationService.v1.dll
Syntax
public class QuotaFailureViolation : IDirectResponseSchema

Properties

ApiService

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".

Declaration
[JsonProperty("apiService")]
public virtual string ApiService { get; set; }
Property Value
Type Description
string

Description

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".

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FutureQuotaValue

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.

Declaration
[JsonProperty("futureQuotaValue")]
public virtual long? FutureQuotaValue { get; set; }
Property Value
Type Description
long?

QuotaDimensions

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.

Declaration
[JsonProperty("quotaDimensions")]
public virtual IDictionary<string, string> QuotaDimensions { get; set; }
Property Value
Type Description
IDictionary<string, string>

QuotaId

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".

Declaration
[JsonProperty("quotaId")]
public virtual string QuotaId { get; set; }
Property Value
Type Description
string

QuotaMetric

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".

Declaration
[JsonProperty("quotaMetric")]
public virtual string QuotaMetric { get; set; }
Property Value
Type Description
string

QuotaValue

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.

Declaration
[JsonProperty("quotaValue")]
public virtual long? QuotaValue { get; set; }
Property Value
Type Description
long?

Subject

The subject on which the quota check failed. For example, "clientip:" or "project:".

Declaration
[JsonProperty("subject")]
public virtual string Subject { get; set; }
Property Value
Type Description
string

Implements