PHPFUI/InstaDoc
 
Copied!

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

Generated from protobuf message google.rpc.QuotaFailure.Violation

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $subject
      The subject on which the quota check failed.
      For example, "clientip:<ip address of client>" or "project:<Google
      developer project id>".
@type 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".
@type string $api_service
      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".
@type string $quota_metric
      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".
@type string $quota_id
      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".
@type array|\Google\Protobuf\Internal\MapField $quota_dimensions
      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.
@type int|string $quota_value
      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.
@type int|string $future_quota_value
      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.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearFutureQuotaValue()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public 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".

Generated from protobuf field string api_service = 3;

  • return string
public 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".

Generated from protobuf field string description = 2;

  • return string
public 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.

Generated from protobuf field optional int64 future_quota_value = 8;

  • return int|string
public getQuotaDimensions()
 

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.

Generated from protobuf field map<string, string> quota_dimensions = 6;

  • return \Google\Protobuf\Internal\MapField
public 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".

Generated from protobuf field string quota_id = 5;

  • return string
public 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".

Generated from protobuf field string quota_metric = 4;

  • return string
public 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.

Generated from protobuf field int64 quota_value = 7;

  • return int|string
public getSubject()
 

The subject on which the quota check failed.

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1;

  • return string
public hasFutureQuotaValue()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setApiService( $var)
 

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

Generated from protobuf field string api_service = 3;

  • param string $var
  • return $this
public setDescription( $var)
 

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

Generated from protobuf field string description = 2;

  • param string $var
  • return $this
public setFutureQuotaValue( $var)
 

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.

Generated from protobuf field optional int64 future_quota_value = 8;

  • param int|string $var
  • return $this
public setQuotaDimensions( $var)
 

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.

Generated from protobuf field map<string, string> quota_dimensions = 6;

  • param array|\Google\Protobuf\Internal\MapField $var
  • return $this
public setQuotaId( $var)
 

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

Generated from protobuf field string quota_id = 5;

  • param string $var
  • return $this
public setQuotaMetric( $var)
 

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

Generated from protobuf field string quota_metric = 4;

  • param string $var
  • return $this
public setQuotaValue( $var)
 

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.

Generated from protobuf field int64 quota_value = 7;

  • param int|string $var
  • return $this
public setSubject( $var)
 

The subject on which the quota check failed.

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1;

  • param string $var
  • return $this
Properties
protected $api_service = ''
 

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

Generated from protobuf field string api_service = 3;

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

Generated from protobuf field string description = 2;

protected $future_quota_value = NULL
 

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.

Generated from protobuf field optional int64 future_quota_value = 8;

protected $quota_id = ''
 

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

Generated from protobuf field string quota_id = 5;

protected $quota_metric = ''
 

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

Generated from protobuf field string quota_metric = 4;

protected $quota_value = 0
 

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.

Generated from protobuf field int64 quota_value = 7;

protected $subject = ''
 

The subject on which the quota check failed.

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $quota_dimensions = NULL
 

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.

Generated from protobuf field map<string, string> quota_dimensions = 6;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration