PHPFUI/InstaDoc
 
Copied!

Quota configuration helps to achieve fairness and budgeting in service usage.

The metric based quota configuration works this way:

  • The service configuration defines a set of metrics.
  • For API calls, the quota.metric_rules maps methods to metrics with corresponding costs.
  • The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits:
    • name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules:
    • selector: "*" metric_costs: library.googleapis.com/read_calls: 1
    • selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2
    • selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
    • name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64
    • name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

Generated from protobuf message google.api.Quota

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type array<\Google\Api\QuotaLimit>|\Google\Protobuf\Internal\RepeatedField $limits
      List of QuotaLimit definitions for the service.
@type array<\Google\Api\MetricRule>|\Google\Protobuf\Internal\RepeatedField $metric_rules
      List of MetricRule definitions, each one mapping a selected method to one
      or more metrics.
    }
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 Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getLimits()
 

List of QuotaLimit definitions for the service.

Generated from protobuf field repeated .google.api.QuotaLimit limits = 3;

  • return \Google\Protobuf\Internal\RepeatedField
public getMetricRules()
 

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

Generated from protobuf field repeated .google.api.MetricRule metric_rules = 4;

  • return \Google\Protobuf\Internal\RepeatedField
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 setLimits( $var)
 

List of QuotaLimit definitions for the service.

Generated from protobuf field repeated .google.api.QuotaLimit limits = 3;

  • param \Google\Api\QuotaLimit[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setMetricRules( $var)
 

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

Generated from protobuf field repeated .google.api.MetricRule metric_rules = 4;

  • param \Google\Api\MetricRule[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
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 $limits = NULL
 

List of QuotaLimit definitions for the service.

Generated from protobuf field repeated .google.api.QuotaLimit limits = 3;

private $metric_rules = NULL
 

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

Generated from protobuf field repeated .google.api.MetricRule metric_rules = 4;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration