http4s-grpc-google-common-protos/com.google/com.google.api/com.google.api.usage/UsageRule

UsageRule

com.google.api.usage.UsageRule

See theUsageRule companion object

final case class UsageRule(selector: String, allowUnregisteredCalls: Boolean, skipServiceControl: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UsageRule]

Usage configuration rules for the service.

NOTE: Under development.

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). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls.

Example of an API that wants to allow unregistered calls for entire service.

usage: rules:

selector: "*" allow_unregistered_calls: true

Example of a method that wants to allow unregistered calls.

usage: rules:

selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true

Value parameters

allowUnregisteredCalls: If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
selector: Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
skipServiceControl: 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 Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

Attributes

Companion: object
Source: UsageRule.scala
Graph
Supertypes: trait Updatable[UsageRule]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all