Usage

JSON representation
UsageRule
- JSON representation

Configuration controlling usage of a service.

JSON representation
{ "requirements": [ string ], "rules": [ { object (`UsageRule`) } ], "producerNotificationChannel": string }

Fields

Fields
`requirements[]`	`string` 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 Trusted Cloud APIs, a Terms of Service requirement must be included here. Trusted Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Trusted Cloud APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
`rules[]`	`object (UsageRule)` A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
`producerNotificationChannel`	`string` The full resource name of a channel used for sending notifications to the service producer. Trusted Cloud Service Management currently only supports Trusted Cloud Pub/Sub as a notification channel. To use Trusted 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://paris.devsitetest.how/pubsub/docs/overview.

requirements[]

string

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 Trusted Cloud APIs, a Terms of Service requirement must be included here. Trusted Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Trusted Cloud APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

rules[]

object (UsageRule)

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

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

producerNotificationChannel

string

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

Trusted Cloud Service Management currently only supports Trusted Cloud Pub/Sub as a notification channel. To use Trusted 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://paris.devsitetest.how/pubsub/docs/overview.

UsageRule

Usage configuration rules for the service.

JSON representation
{ "selector": string, "allowUnregisteredCalls": boolean, "skipServiceControl": boolean }

Fields

Fields
`selector`	`string` Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to `selector` for syntax details.
`allowUnregisteredCalls`	`boolean` Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.
`skipServiceControl`	`boolean` If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Trusted Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

selector

string

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

Refer to selector for syntax details.

allowUnregisteredCalls

boolean

Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key).

WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.

skipServiceControl

boolean

If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Trusted Cloud Endpoints to bypass checks for internal methods, such as service health check methods.