final case class SystemParameters(rules: Seq[SystemParameterRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SystemParameters] with Product with Serializable

### 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.

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.
Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[SystemParameters], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SystemParameters
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SystemParameters(rules: Seq[SystemParameterRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllRules(__vs: Iterable[SystemParameterRule]): SystemParameters
  5. def addRules(__vs: SystemParameterRule*): SystemParameters
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearRules: SystemParameters
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companion: SystemParameters.type
    Definition Classes
    SystemParameters → GeneratedMessage
  10. def discardUnknownFields: SystemParameters
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    SystemParameters → GeneratedMessage
  15. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    SystemParameters → GeneratedMessage
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val rules: Seq[SystemParameterRule]
  21. def serializedSize: Int
    Definition Classes
    SystemParameters → GeneratedMessage
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    SystemParameters → GeneratedMessage
  27. val unknownFields: UnknownFieldSet
  28. def update(ms: (Lens[SystemParameters, SystemParameters]) ⇒ Mutation[SystemParameters]*): SystemParameters
    Definition Classes
    Updatable
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def withRules(__v: Seq[SystemParameterRule]): SystemParameters
  33. def withUnknownFields(__v: UnknownFieldSet): SystemParameters
  34. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  35. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    SystemParameters → GeneratedMessage
  36. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[SystemParameters]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped