Class 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.

Inheritance
System.Object
SystemParameters
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class SystemParameters : IMessage<SystemParameters>, IMessage, IEquatable<SystemParameters>, IDeepCloneable<SystemParameters>

Constructors

SystemParameters()

Declaration
public SystemParameters()

SystemParameters(SystemParameters)

Declaration
public SystemParameters(SystemParameters other)
Parameters
Type Name Description
SystemParameters other

Fields

RulesFieldNumber

Field number for the "rules" field.

Declaration
public const int RulesFieldNumber = 1
Field Value
Type Description
System.Int32

Properties

Descriptor

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

Parser

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

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.

Declaration
public RepeatedField<SystemParameterRule> Rules { get; }
Property Value
Type Description
RepeatedField<SystemParameterRule>

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public SystemParameters Clone()
Returns
Type Description
SystemParameters
Implements

Equals(SystemParameters)

Declaration
public bool Equals(SystemParameters other)
Parameters
Type Name Description
SystemParameters other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(SystemParameters)

Declaration
public void MergeFrom(SystemParameters other)
Parameters
Type Name Description
SystemParameters other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements