Class Help (2.15.0)

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

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Inheritance

object > Help

Implements

IMessage Help, IEquatable Help, IDeepCloneable Help, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

Help()

public Help()

Help(Help)

public Help(Help other)

Parameter
Name	Description
`other`	`Help`

Fields

LinksFieldNumber

public const int LinksFieldNumber = 1

Field number for the "links" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Links

public RepeatedField<Help.Types.Link> Links { get; }

URL(s) pointing to additional information on handling the current error.

Property Value
Type	Description
`RepeatedFieldHelpTypesLink`

Parser

public static MessageParser<Help> Parser { get; }

Property Value
Type	Description
`MessageParserHelp`

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 Help Clone()

Creates a deep clone of this object.

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

Equals(Help)

public bool Equals(Help other)

Parameter
Name	Description
`other`	`Help`

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

MergeFrom(Help)

public void MergeFrom(Help other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`Help`

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.