Package com.google.rpc

Interface QuotaFailure.ViolationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
QuotaFailure.Violation, QuotaFailure.Violation.Builder
Enclosing class:
QuotaFailure
public static interface QuotaFailure.ViolationOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • getSubject

      String getSubject()
       The subject on which the quota check failed.
 For example, "clientip:<ip address of client>" or "project:<Google
 developer project id>".
      string subject = 1 [json_name = "subject"];
      Returns:
      The subject.

    • getSubjectBytes

      com.google.protobuf.ByteString getSubjectBytes()
       The subject on which the quota check failed.
 For example, "clientip:<ip address of client>" or "project:<Google
 developer project id>".
      string subject = 1 [json_name = "subject"];
      Returns:
      The bytes for subject.

    • getDescription

      String getDescription()
       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".
      string description = 2 [json_name = "description"];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       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".
      string description = 2 [json_name = "description"];
      Returns:
      The bytes for description.

    • getApiService

      String getApiService()
       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".
      string api_service = 3 [json_name = "apiService"];
      Returns:
      The apiService.

    • getApiServiceBytes

      com.google.protobuf.ByteString getApiServiceBytes()
       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".
      string api_service = 3 [json_name = "apiService"];
      Returns:
      The bytes for apiService.

    • getQuotaMetric

      String getQuotaMetric()
       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".
      string quota_metric = 4 [json_name = "quotaMetric"];
      Returns:
      The quotaMetric.

    • getQuotaMetricBytes

      com.google.protobuf.ByteString getQuotaMetricBytes()
       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".
      string quota_metric = 4 [json_name = "quotaMetric"];
      Returns:
      The bytes for quotaMetric.

    • getQuotaId

      String getQuotaId()
       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".
      string quota_id = 5 [json_name = "quotaId"];
      Returns:
      The quotaId.

    • getQuotaIdBytes

      com.google.protobuf.ByteString getQuotaIdBytes()
       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".
      string quota_id = 5 [json_name = "quotaId"];
      Returns:
      The bytes for quotaId.

    • getQuotaDimensionsCount

      int getQuotaDimensionsCount()
       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.
      map<string, string> quota_dimensions = 6 [json_name = "quotaDimensions"];

    • containsQuotaDimensions

      boolean containsQuotaDimensions(String key)
       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.
      map<string, string> quota_dimensions = 6 [json_name = "quotaDimensions"];

    • getQuotaDimensions

      @Deprecated Map<String,String> getQuotaDimensions()
      Deprecated.
      Use getQuotaDimensionsMap() instead.

    • getQuotaDimensionsMap

      Map<String,String> getQuotaDimensionsMap()
       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.
      map<string, string> quota_dimensions = 6 [json_name = "quotaDimensions"];

    • getQuotaDimensionsOrDefault

      String getQuotaDimensionsOrDefault(String key, String defaultValue)
       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.
      map<string, string> quota_dimensions = 6 [json_name = "quotaDimensions"];

    • getQuotaDimensionsOrThrow

      String getQuotaDimensionsOrThrow(String key)
       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.
      map<string, string> quota_dimensions = 6 [json_name = "quotaDimensions"];

    • getQuotaValue

      long getQuotaValue()
       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.
      int64 quota_value = 7 [json_name = "quotaValue"];
      Returns:
      The quotaValue.

    • hasFutureQuotaValue

      boolean hasFutureQuotaValue()
       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.
      optional int64 future_quota_value = 8 [json_name = "futureQuotaValue"];
      Returns:
      Whether the futureQuotaValue field is set.

    • getFutureQuotaValue

      long getFutureQuotaValue()
       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.
      optional int64 future_quota_value = 8 [json_name = "futureQuotaValue"];
      Returns:
      The futureQuotaValue.