Class LocalizedMessage (2.38.0)

public final class LocalizedMessage extends GeneratedMessageV3 implements LocalizedMessageOrBuilder

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

Protobuf type google.rpc.LocalizedMessage

Static Fields

LOCALE_FIELD_NUMBER

public static final int LOCALE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LocalizedMessage getDefaultInstance()
Returns
Type Description
LocalizedMessage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LocalizedMessage.Builder newBuilder()
Returns
Type Description
LocalizedMessage.Builder

newBuilder(LocalizedMessage prototype)

public static LocalizedMessage.Builder newBuilder(LocalizedMessage prototype)
Parameter
Name Description
prototype LocalizedMessage
Returns
Type Description
LocalizedMessage.Builder

parseDelimitedFrom(InputStream input)

public static LocalizedMessage parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LocalizedMessage parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocalizedMessage parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocalizedMessage parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LocalizedMessage parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LocalizedMessage parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalizedMessage
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LocalizedMessage> parser()
Returns
Type Description
Parser<LocalizedMessage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public LocalizedMessage getDefaultInstanceForType()
Returns
Type Description
LocalizedMessage

getLocale()

public String getLocale()

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"

string locale = 1;

Returns
Type Description
String

The locale.

getLocaleBytes()

public ByteString getLocaleBytes()

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"

string locale = 1;

Returns
Type Description
ByteString

The bytes for locale.

getMessage()

public String getMessage()

The localized error message in the above locale.

string message = 2;

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

The localized error message in the above locale.

string message = 2;

Returns
Type Description
ByteString

The bytes for message.

getParserForType()

public Parser<LocalizedMessage> getParserForType()
Returns
Type Description
Parser<LocalizedMessage>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LocalizedMessage.Builder newBuilderForType()
Returns
Type Description
LocalizedMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LocalizedMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LocalizedMessage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LocalizedMessage.Builder toBuilder()
Returns
Type Description
LocalizedMessage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException