Class SystemParameter (2.15.0)

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

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

Inheritance

object > SystemParameter

Implements

IMessage SystemParameter, IEquatable SystemParameter, IDeepCloneable SystemParameter, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

SystemParameter()

public SystemParameter()

SystemParameter(SystemParameter)

public SystemParameter(SystemParameter other)

Parameter
Name	Description
`other`	`SystemParameter`

Fields

HttpHeaderFieldNumber

public const int HttpHeaderFieldNumber = 2

Field number for the "http_header" field.

Field Value
Type	Description
`int`

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type	Description
`int`

UrlQueryParameterFieldNumber

public const int UrlQueryParameterFieldNumber = 3

Field number for the "url_query_parameter" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

HttpHeader

public string HttpHeader { get; set; }

Define the HTTP header name to use for the parameter. It is case insensitive.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

Define the name of the parameter, such as "api_key" . It is case sensitive.

Property Value
Type	Description
`string`

Parser

public static MessageParser<SystemParameter> Parser { get; }

Property Value
Type	Description
`MessageParserSystemParameter`

UrlQueryParameter

public string UrlQueryParameter { get; set; }

Define the URL query parameter name to use for the parameter. It is case sensitive.

Property Value
Type	Description
`string`

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public SystemParameter Clone()

Creates a deep clone of this object.

Returns
Type	Description
`SystemParameter`	A deep clone of this object.

Equals(SystemParameter)

public bool Equals(SystemParameter other)

Parameter
Name	Description
`other`	`SystemParameter`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(SystemParameter)

public void MergeFrom(SystemParameter other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`SystemParameter`

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.