Class LocalizedMessage

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

Fields

LOCALE_FIELD_NUMBER

public static final int LOCALE_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static LocalizedMessage getDefaultInstance()
Returns
TypeDescription
LocalizedMessage

getDefaultInstanceForType()

public LocalizedMessage getDefaultInstanceForType()
Returns
TypeDescription
LocalizedMessage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getLocale()

public String getLocale()

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

string locale = 1;

Returns
TypeDescription
String

The locale.

getLocaleBytes()

public ByteString getLocaleBytes()

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

string locale = 1;

Returns
TypeDescription
ByteString

The bytes for locale.

getMessage()

public String getMessage()

The localized error message in the above locale.

string message = 2;

Returns
TypeDescription
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

The localized error message in the above locale.

string message = 2;

Returns
TypeDescription
ByteString

The bytes for message.

getParserForType()

public Parser<LocalizedMessage> getParserForType()
Returns
TypeDescription
Parser<LocalizedMessage>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static LocalizedMessage.Builder newBuilder()
Returns
TypeDescription
LocalizedMessage.Builder

newBuilder(LocalizedMessage prototype)

public static LocalizedMessage.Builder newBuilder(LocalizedMessage prototype)
Parameter
NameDescription
prototypeLocalizedMessage
Returns
TypeDescription
LocalizedMessage.Builder

newBuilderForType()

public LocalizedMessage.Builder newBuilderForType()
Returns
TypeDescription
LocalizedMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LocalizedMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LocalizedMessage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static LocalizedMessage parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LocalizedMessage parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocalizedMessage parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocalizedMessage parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LocalizedMessage parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LocalizedMessage parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocalizedMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LocalizedMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LocalizedMessage> parser()
Returns
TypeDescription
Parser<LocalizedMessage>

toBuilder()

public LocalizedMessage.Builder toBuilder()
Returns
TypeDescription
LocalizedMessage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException