Class LocalizedMessage (2.15.0)

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

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Inheritance

object > LocalizedMessage

Implements

IMessage LocalizedMessage, IEquatable LocalizedMessage, IDeepCloneable LocalizedMessage, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

LocalizedMessage()

public LocalizedMessage()

LocalizedMessage(LocalizedMessage)

public LocalizedMessage(LocalizedMessage other)

Parameter
Name	Description
`other`	`LocalizedMessage`

Fields

LocaleFieldNumber

public const int LocaleFieldNumber = 1

Field number for the "locale" field.

Field Value
Type	Description
`int`

MessageFieldNumber

public const int MessageFieldNumber = 2

Field number for the "message" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Locale

public string Locale { get; set; }

The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"

Property Value
Type	Description
`string`

Message

public string Message { get; set; }

The localized error message in the above locale.

Property Value
Type	Description
`string`

Parser

public static MessageParser<LocalizedMessage> Parser { get; }

Property Value
Type	Description
`MessageParserLocalizedMessage`

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

Creates a deep clone of this object.

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

Equals(LocalizedMessage)

public bool Equals(LocalizedMessage other)

Parameter
Name	Description
`other`	`LocalizedMessage`

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(LocalizedMessage)

public void MergeFrom(LocalizedMessage other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`LocalizedMessage`

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.