com.google.api.consumer

Members list

Concise view

Type members

Classlikes

object ConsumerProto extends GeneratedFileObject

Attributes

Source:
ConsumerProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ProjectProperties(properties: Seq[Property], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ProjectProperties]

A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client. This descriptor defines which properties are allowed to be set on a project.

A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client. This descriptor defines which properties are allowed to be set on a project.

Example:

project_properties: properties: - name: NO_WATERMARK type: BOOL description: Allows usage of the API without watermarks. - name: EXTENDED_TILE_CACHE_PERIOD type: INT64

Attributes

properties

List of per consumer project-specific properties.

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

Attributes

Companion:
class
Source:
ProjectProperties.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProjectProperties]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Property(name: String, `type`: PropertyType, description: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Property]

Defines project properties.

Defines project properties.

API services can define properties that can be assigned to consumer projects so that backends can perform response customization without having to make additional calls or maintain additional storage. For example, Maps API defines properties that controls map tile cache period, or whether to embed a watermark in a result.

These values can be set via API producer console. Only API providers can define and set these properties.

Attributes

description

The description of the property

name

The name of the property (a.k.a key).

type

The type of this property.

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

Attributes

Companion:
class
Source:
Property.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Property]
trait Serializable
class Object
trait Matchable
class Any
Self type