PHPFUI/InstaDoc
 
Copied!

Configuration controlling usage of a service.

Generated from protobuf message google.api.Usage

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type array<string>|\Google\Protobuf\Internal\RepeatedField $requirements
      Requirements that must be satisfied before a consumer project can use the
      service. Each requirement is of the form <service.name>/<requirement-id>;
      for example 'serviceusage.googleapis.com/billing-enabled'.
      For Google APIs, a Terms of Service requirement must be included here.
      Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud".
      Other Google APIs should include
      "serviceusage.googleapis.com/tos/universal". Additional ToS can be
      included based on the business needs.
@type array<\Google\Api\UsageRule>|\Google\Protobuf\Internal\RepeatedField $rules
      A list of usage rules that apply to individual API methods.
      **NOTE:** All service configuration rules follow "last one wins" order.
@type string $producer_notification_channel
      The full resource name of a channel used for sending notifications to the
      service producer.
      Google Service Management currently only supports
      [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
      channel. To use Google Cloud Pub/Sub as the channel, this must be the name
      of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
      documented in https://cloud.google.com/pubsub/docs/overview.
    }
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 getProducerNotificationChannel()
 

The full resource name of a channel used for sending notifications to the service producer.

Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

Generated from protobuf field string producer_notification_channel = 7;

  • return string
public getRequirements()
 

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/; for example 'serviceusage.googleapis.com/billing-enabled'.

For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

Generated from protobuf field repeated string requirements = 1;

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

A list of usage rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.UsageRule rules = 6;

  • 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 setProducerNotificationChannel( $var)
 

The full resource name of a channel used for sending notifications to the service producer.

Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

Generated from protobuf field string producer_notification_channel = 7;

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

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/; for example 'serviceusage.googleapis.com/billing-enabled'.

For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

Generated from protobuf field repeated string requirements = 1;

  • param string[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setRules( $var)
 

A list of usage rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.UsageRule rules = 6;

  • param \Google\Api\UsageRule[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
Properties
protected $producer_notification_channel = ''
 

The full resource name of a channel used for sending notifications to the service producer.

Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

Generated from protobuf field string producer_notification_channel = 7;

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

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/; for example 'serviceusage.googleapis.com/billing-enabled'.

For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

Generated from protobuf field repeated string requirements = 1;

private $rules = NULL
 

A list of usage rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.UsageRule rules = 6;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration