Send feedback
Class SystemParameters (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
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)
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; }
Parser
public static MessageParser<SystemParameters> Parser { get; }
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.
Methods
CalculateSize()
public int CalculateSize()
Returns
Type
Description
int
Clone()
public SystemParameters Clone()
Equals(SystemParameters)
public bool Equals(SystemParameters other)
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)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
Returns
Type
Description
string
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-01 UTC."]]