Google API Common Protos Client - Class Usage (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class Usage.

Configuration controlling usage of a service.

Generated from protobuf message google.api.Usage

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ requirements array

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/

↳ rules array<Google\Api\UsageRule>

A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

↳ producer_notification_channel string

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.

getRequirements

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRequirements

Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getRules

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

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRules

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

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

Parameter
Name Description
var array<Google\Api\UsageRule>
Returns
Type Description
$this

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.

Returns
Type Description
string

setProducerNotificationChannel

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.

Parameter
Name Description
var string
Returns
Type Description
$this