Class: Google::Api::SystemParameters

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/system_parameter.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#rules ⇒ ::Array<::Google::Api::SystemParameterRule>

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

Returns:

  • (::Array<::Google::Api::SystemParameterRule>) —

    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.



59
60
61
62
 
# File 'proto_docs/google/api/system_parameter.rb', line 59

class SystemParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end