root
API
Generated with
root/com.google/com.google.api/com.google.api.system_parameter/SystemParameters

SystemParameters

com.google.api.system_parameter.SystemParameters
See theSystemParameters companion object
final case class SystemParameters(rules: Seq[SystemParameterRule], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SystemParameters]

System parameter configuration

A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

Value parameters

rules

Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.

Attributes

Companion
object
Source
SystemParameters.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def companion: SystemParameters.type

Attributes

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

Attributes

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

Attributes

Source
SystemParameters.scala
override def serializedSize: Int

Attributes

Definition Classes
Source
SystemParameters.scala
def toProtoString: String

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
SystemParameters.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
SystemParameters.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

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[SystemParameters, SystemParameters]) => () => SystemParameters*): SystemParameters

Attributes

Inherited from:
Updatable
Source
Lenses.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
Generated with