Service Management V1 API - Class Google::Api::SystemParameters (v0.3.10)

Reference documentation and code samples for the Service Management V1 API class Google::Api::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#rules

def rules() -> ::Array<::Google::Api::SystemParameterRule>

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.

#rules=

def rules=(value) -> ::Array<::Google::Api::SystemParameterRule>

Parameter

value (::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.

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.