1. class
  2. Google
  3. \
  4. Api
  5. \
  6. SystemParameters

SystemParameters

class SystemParameters extends Message

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.

Generated from protobuf message google.api.SystemParameters

Methods

__construct(array $data = NULL)

Constructor.

RepeatedField
getRules()

Define system parameters.

$this
setRules(SystemParameterRule[]|RepeatedField $var)

Define system parameters.

Details

at line 81
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type \Google\Api\SystemParameterRule[]|\Google\Protobuf\Internal\RepeatedField $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.

}

at line 113
RepeatedField getRules()

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.

Generated from protobuf field repeated .google.api.SystemParameterRule rules = 1;

Return Value

RepeatedField

at line 146
$this setRules(SystemParameterRule[]|RepeatedField $var)

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.

Generated from protobuf field repeated .google.api.SystemParameterRule rules = 1;

Parameters

SystemParameterRule[]|RepeatedField $var

Return Value

$this