public static final class LocalizedMessage.Builder extends GeneratedMessageV3.Builder<LocalizedMessage.Builder> implements LocalizedMessageOrBuilderProvides 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LocalizedMessage.BuilderImplements
LocalizedMessageOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LocalizedMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
build()
public LocalizedMessage build()| Returns | |
|---|---|
| Type | Description |
LocalizedMessage |
|
buildPartial()
public LocalizedMessage buildPartial()| Returns | |
|---|---|
| Type | Description |
LocalizedMessage |
|
clear()
public LocalizedMessage.Builder clear()| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public LocalizedMessage.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
clearLocale()
public LocalizedMessage.Builder clearLocale()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 |
LocalizedMessage.Builder |
This builder for chaining. |
clearMessage()
public LocalizedMessage.Builder clearMessage()The localized error message in the above locale.
string message = 2;
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public LocalizedMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
clone()
public LocalizedMessage.Builder clone()| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
getDefaultInstanceForType()
public LocalizedMessage getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LocalizedMessage |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LocalizedMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public LocalizedMessage.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
mergeFrom(LocalizedMessage other)
public LocalizedMessage.Builder mergeFrom(LocalizedMessage other)| Parameter | |
|---|---|
| Name | Description |
other |
LocalizedMessage |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LocalizedMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public LocalizedMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
setLocale(String value)
public LocalizedMessage.Builder setLocale(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe locale to set. |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
This builder for chaining. |
setLocaleBytes(ByteString value)
public LocalizedMessage.Builder setLocaleBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for locale to set. |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
This builder for chaining. |
setMessage(String value)
public LocalizedMessage.Builder setMessage(String value)The localized error message in the above locale.
string message = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe message to set. |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
This builder for chaining. |
setMessageBytes(ByteString value)
public LocalizedMessage.Builder setMessageBytes(ByteString value)The localized error message in the above locale.
string message = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for message to set. |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LocalizedMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final LocalizedMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
LocalizedMessage.Builder |
|