google_api_service_consumer_management v0.18.0 GoogleApi.ServiceConsumerManagement.V1.Model.SystemParameters View Source

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.

Attributes

  • rules (type: list(GoogleApi.ServiceConsumerManagement.V1.Model.SystemParameterRule.t), default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.ServiceConsumerManagement.V1.Model.SystemParameters{
  rules: [GoogleApi.ServiceConsumerManagement.V1.Model.SystemParameterRule.t()]
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.