Class SystemParameters

public sealed class SystemParameters : Protobuf.IMessage<SystemParameters>, Protobuf.IBufferMessage

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
TypeNameDescription
SystemParametersother

Fields

RulesFieldNumber

public const int RulesFieldNumber = 1

Field number for the "rules" field.

Field Value
TypeDescription
Int32

Properties

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

Parser

public static Protobuf.MessageParser<SystemParameters> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<SystemParameters>

Rules

public Protobuf.Collections.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
TypeDescription
Protobuf.Collections.RepeatedField<SystemParameterRule>

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public SystemParameters Clone()
Returns
TypeDescription
SystemParameters

Equals(SystemParameters)

public bool Equals(SystemParameters other)
Parameter
TypeNameDescription
SystemParametersother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(SystemParameters)

public void MergeFrom(SystemParameters other)
Parameter
TypeNameDescription
SystemParametersother

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
TypeNameDescription
Protobuf.CodedInputStreaminput

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
TypeNameDescription
Protobuf.CodedOutputStreamoutput

Implements