Class SystemParameters (2.17.0) 

public sealed class SystemParameters : IMessage<SystemParameters>, IEquatable<SystemParameters>, IDeepCloneable<SystemParameters>, IBufferMessage, IMessage

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.

Inheritance

object > SystemParameters

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

SystemParameters()

public SystemParameters()

SystemParameters(SystemParameters)

public SystemParameters(SystemParameters other)
Parameter
Name Description
other SystemParameters

Fields

RulesFieldNumber

public const int RulesFieldNumber = 1

Field number for the "rules" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Parser

public static MessageParser<SystemParameters> Parser { get; }
Property Value
Type Description
MessageParserSystemParameters

Rules

public RepeatedField<SystemParameterRule> Rules { get; }

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.

Property Value
Type Description
RepeatedFieldSystemParameterRule

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public SystemParameters Clone()
Returns
Type Description
SystemParameters

Equals(SystemParameters)

public bool Equals(SystemParameters other)
Parameter
Name Description
other SystemParameters
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(SystemParameters)

public void MergeFrom(SystemParameters other)
Parameter
Name Description
other SystemParameters

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream