PHPFUI/InstaDoc
 
Copied!

QuotaLimit defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a QuotaGroup.

Generated from protobuf message google.api.QuotaLimit

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
      Name of the quota limit.
      The name must be provided, and it must be unique within the service. The
      name can only include alphanumeric characters as well as '-'.
      The maximum length of the limit name is 64 characters.
@type string $description
      Optional. User-visible, extended description for this quota limit.
      Should be used only when more context is needed to understand this limit
      than provided by the limit's display name (see: `display_name`).
@type int|string $default_limit
      Default number of tokens that can be consumed during the specified
      duration. This is the number of tokens assigned when a client
      application developer activates the service for his/her project.
      Specifying a value of 0 will block all requests. This can be used if you
      are provisioning quota to selected consumers and blocking others.
      Similarly, a value of -1 will indicate an unlimited quota. No other
      negative values are allowed.
      Used by group-based quotas only.
@type int|string $max_limit
      Maximum number of tokens that can be consumed during the specified
      duration. Client application developers can override the default limit up
      to this maximum. If specified, this value cannot be set to a value less
      than the default limit. If not specified, it is set to the default limit.
      To allow clients to apply overrides with no upper bound, set this to -1,
      indicating unlimited maximum quota.
      Used by group-based quotas only.
@type int|string $free_tier
      Free tier value displayed in the Developers Console for this limit.
      The free tier is the number of tokens that will be subtracted from the
      billed amount when billing is enabled.
      This field can only be set on a limit with duration "1d", in a billable
      group; it is invalid on any other limit. If this field is not set, it
      defaults to 0, indicating that there is no free tier for this service.
      Used by group-based quotas only.
@type string $duration
      Duration of this limit in textual notation. Must be "100s" or "1d".
      Used by group-based quotas only.
@type string $metric
      The name of the metric this quota limit applies to. The quota limits with
      the same metric will be checked together during runtime. The metric must be
      defined within the service config.
@type string $unit
      Specify the unit of the quota limit. It uses the same syntax as
      [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
      unit kinds are determined by the quota backend system.
      Here are some examples:
      *          * "1/min/{project}" for quota per minute per project.
      Note: the order of unit components is insignificant.
      The "1" at the beginning is required to follow the metric unit syntax.
@type array|\Google\Protobuf\Internal\MapField $values
      Tiered limit values. You must specify this as a key:value pair, with an
      integer value that is the maximum number of requests allowed for the
      specified unit. Currently only STANDARD is supported.
@type string $display_name
      User-visible display name for this limit.
      Optional. If not set, the UI will provide a default display name based on
      the quota configuration. This field can be used to override the default
      display name generated from the configuration.
    }
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 getDefaultLimit()
 

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.

Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.

Generated from protobuf field int64 default_limit = 3;

  • return int|string
public getDescription()
 

Optional. User-visible, extended description for this quota limit.

Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: display_name).

Generated from protobuf field string description = 2;

  • return string
public getDisplayName()
 

User-visible display name for this limit.

Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.

Generated from protobuf field string display_name = 12;

  • return string
public getDuration()
 

Duration of this limit in textual notation. Must be "100s" or "1d".

Used by group-based quotas only.

Generated from protobuf field string duration = 5;

  • return string
public getFreeTier()
 

Free tier value displayed in the Developers Console for this limit.

The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.

Generated from protobuf field int64 free_tier = 7;

  • return int|string
public getMaxLimit()
 

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.

To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.

Generated from protobuf field int64 max_limit = 4;

  • return int|string
public getMetric()
 

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.

Generated from protobuf field string metric = 8;

  • return string
public getName()
 

Name of the quota limit.

The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.

Generated from protobuf field string name = 6;

  • return string
public getUnit()
 

Specify the unit of the quota limit. It uses the same syntax as [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported unit kinds are determined by the quota backend system.

Here are some examples:

  • "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.

Generated from protobuf field string unit = 9;

  • return string
public getValues()
 

Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.

Generated from protobuf field map<string, int64> values = 10;

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

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.

Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.

Generated from protobuf field int64 default_limit = 3;

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

Optional. User-visible, extended description for this quota limit.

Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: display_name).

Generated from protobuf field string description = 2;

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

User-visible display name for this limit.

Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.

Generated from protobuf field string display_name = 12;

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

Duration of this limit in textual notation. Must be "100s" or "1d".

Used by group-based quotas only.

Generated from protobuf field string duration = 5;

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

Free tier value displayed in the Developers Console for this limit.

The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.

Generated from protobuf field int64 free_tier = 7;

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

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.

To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.

Generated from protobuf field int64 max_limit = 4;

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

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.

Generated from protobuf field string metric = 8;

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

Name of the quota limit.

The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.

Generated from protobuf field string name = 6;

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

Specify the unit of the quota limit. It uses the same syntax as [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported unit kinds are determined by the quota backend system.

Here are some examples:

  • "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.

Generated from protobuf field string unit = 9;

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

Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.

Generated from protobuf field map<string, int64> values = 10;

  • param array|\Google\Protobuf\Internal\MapField $var
  • return $this
Properties
protected $default_limit = 0
 

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.

Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.

Generated from protobuf field int64 default_limit = 3;

protected $description = ''
 

Optional. User-visible, extended description for this quota limit.

Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: display_name).

Generated from protobuf field string description = 2;

protected $display_name = ''
 

User-visible display name for this limit.

Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.

Generated from protobuf field string display_name = 12;

protected $duration = ''
 

Duration of this limit in textual notation. Must be "100s" or "1d".

Used by group-based quotas only.

Generated from protobuf field string duration = 5;

protected $free_tier = 0
 

Free tier value displayed in the Developers Console for this limit.

The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.

Generated from protobuf field int64 free_tier = 7;

protected $max_limit = 0
 

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.

To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.

Generated from protobuf field int64 max_limit = 4;

protected $metric = ''
 

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.

Generated from protobuf field string metric = 8;

protected $name = ''
 

Name of the quota limit.

The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.

Generated from protobuf field string name = 6;

protected $unit = ''
 

Specify the unit of the quota limit. It uses the same syntax as [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported unit kinds are determined by the quota backend system.

Here are some examples:

  • "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.

Generated from protobuf field string unit = 9;

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 $values = NULL
 

Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.

Generated from protobuf field map<string, int64> values = 10;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration