Class: Google::Apis::ServiceusageV1::SystemParameters

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.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 Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SystemParameters

Returns a new instance of SystemParameters



3853
3854
3855
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3853

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#rules ⇒ Array<Google::Apis::ServiceusageV1::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. Corresponds to the JSON property rules

Returns:



3851
3852
3853
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3851

def rules
  @rules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3858
3859
3860
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3858

def update!(**args)
  @rules = args[:rules] if args.key?(:rules)
end