Type Members

1.  final case class SystemParameter(name: String = "", httpHeader: String = "", urlQueryParameter: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SystemParameter] with Product with Serializable

   Define a parameter's name and location.

   Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

   name

   Define the name of the parameter, such as "api_key" . It is case sensitive.

   httpHeader

   Define the HTTP header name to use for the parameter. It is case insensitive.

   urlQueryParameter

   Define the URL query parameter name to use for the parameter. It is case sensitive.

   Annotations

   @SerialVersionUID()

2.  final case class SystemParameterRule(selector: String = "", parameters: Seq[SystemParameter] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SystemParameterRule] with Product with Serializable

   Define a system parameter rule mapping system parameter definitions to methods.

   Define a system parameter rule mapping system parameter definitions to methods.

   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.

   parameters

   Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.

   Annotations

   @SerialVersionUID()

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

   ### System parameter configuration

   ### 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()