Usage

com.google.api.usage.Usage
See theUsage companion object
final case class Usage(requirements: Seq[String], rules: Seq[UsageRule], producerNotificationChannel: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Usage]

Configuration controlling usage of a service.

Attributes

producerNotificationChannel

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.

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.

rules

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

Companion:
object
Source:
Usage.scala
Graph
Supertypes
trait Updatable[Usage]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

Source:
Usage.scala

Attributes

Source:
Usage.scala

Attributes

Source:
Usage.scala
def addRules(`__vs`: UsageRule*): Usage

Attributes

Source:
Usage.scala

Attributes

Source:
Usage.scala

Attributes

Source:
Usage.scala
def companion: Usage.type

Attributes

Source:
Usage.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
Usage.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
Usage.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
Usage.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
Usage.scala

Attributes

Source:
Usage.scala

Attributes

Source:
Usage.scala
def withUnknownFields(`__v`: UnknownFieldSet): Usage

Attributes

Source:
Usage.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
Usage.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[Usage, Usage] => () => Usage*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala