1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Usage

Usage

class Usage extends Message

Configuration controlling usage of a service.

Generated from protobuf message google.api.Usage

Methods

__construct(array $data = NULL)

Constructor.

RepeatedField
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'.

$this
setRequirements(string[]|RepeatedField $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'.

RepeatedField
getRules()

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

$this
setRules(UsageRule[]|RepeatedField $var)

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

string
getProducerNotificationChannel()

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

$this
setProducerNotificationChannel(string $var)

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

Details

at line 69
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type 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'.
@type \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.

}

at line 82
RepeatedField 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'.

Generated from protobuf field repeated string requirements = 1;

Return Value

RepeatedField

at line 96
$this setRequirements(string[]|RepeatedField $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'.

Generated from protobuf field repeated string requirements = 1;

Parameters

string[]|RepeatedField $var

Return Value

$this

at line 111
RepeatedField 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 Value

RepeatedField

at line 124
$this setRules(UsageRule[]|RepeatedField $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;

Parameters

UsageRule[]|RepeatedField $var

Return Value

$this

at line 144
string 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 Value

string

at line 162
$this setProducerNotificationChannel(string $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;

Parameters

string $var

Return Value

$this