public static final class Status.Builder extends GeneratedMessageV3.Builder<Status.Builder> implements StatusOrBuilder
The Status type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
API Design Guide.
Protobuf type google.rpc.Status
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllDetails(Iterable<? extends Any> values)
public Status.Builder addAllDetails(Iterable<? extends Any> values)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
values |
Iterable<? extends com.google.protobuf.Any>
|
addDetails(Any value)
public Status.Builder addDetails(Any value)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
value |
Any
|
addDetails(Any.Builder builderForValue)
public Status.Builder addDetails(Any.Builder builderForValue)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
builderForValue |
Builder
|
addDetails(int index, Any value)
public Status.Builder addDetails(int index, Any value)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameters |
| Name |
Description |
index |
int
|
value |
Any
|
addDetails(int index, Any.Builder builderForValue)
public Status.Builder addDetails(int index, Any.Builder builderForValue)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameters |
| Name |
Description |
index |
int
|
builderForValue |
Builder
|
addDetailsBuilder()
public Any.Builder addDetailsBuilder()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
addDetailsBuilder(int index)
public Any.Builder addDetailsBuilder(int index)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
index |
int
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Status.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
| Returns |
| Type |
Description |
Status |
|
buildPartial()
public Status buildPartial()
| Returns |
| Type |
Description |
Status |
|
clear()
public Status.Builder clear()
Overrides
clearCode()
public Status.Builder clearCode()
The status code, which should be an enum value of
google.rpc.Code.
int32 code = 1;
clearDetails()
public Status.Builder clearDetails()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
clearField(Descriptors.FieldDescriptor field)
public Status.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearMessage()
public Status.Builder clearMessage()
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized
by the client.
string message = 2;
clearOneof(Descriptors.OneofDescriptor oneof)
public Status.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public Status.Builder clone()
Overrides
getCode()
The status code, which should be an enum value of
google.rpc.Code.
int32 code = 1;
| Returns |
| Type |
Description |
int |
The code.
|
getDefaultInstanceForType()
public Status getDefaultInstanceForType()
| Returns |
| Type |
Description |
Status |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getDetails(int index)
public Any getDetails(int index)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Any |
|
getDetailsBuilder(int index)
public Any.Builder getDetailsBuilder(int index)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
index |
int
|
getDetailsBuilderList()
public List<Any.Builder> getDetailsBuilderList()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
getDetailsCount()
public int getDetailsCount()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Returns |
| Type |
Description |
int |
|
getDetailsList()
public List<Any> getDetailsList()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
getDetailsOrBuilder(int index)
public AnyOrBuilder getDetailsOrBuilder(int index)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
index |
int
|
getDetailsOrBuilderList()
public List<? extends AnyOrBuilder> getDetailsOrBuilderList()
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Returns |
| Type |
Description |
List<? extends com.google.protobuf.AnyOrBuilder> |
|
getMessage()
public String getMessage()
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized
by the client.
string message = 2;
| Returns |
| Type |
Description |
String |
The message.
|
getMessageBytes()
public ByteString getMessageBytes()
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized
by the client.
string message = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for message.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
public Status.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Status.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeFrom(Status other)
public Status.Builder mergeFrom(Status other)
| Parameter |
| Name |
Description |
other |
Status
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Status.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
removeDetails(int index)
public Status.Builder removeDetails(int index)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameter |
| Name |
Description |
index |
int
|
setCode(int value)
public Status.Builder setCode(int value)
The status code, which should be an enum value of
google.rpc.Code.
int32 code = 1;
| Parameter |
| Name |
Description |
value |
int
The code to set.
|
setDetails(int index, Any value)
public Status.Builder setDetails(int index, Any value)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameters |
| Name |
Description |
index |
int
|
value |
Any
|
setDetails(int index, Any.Builder builderForValue)
public Status.Builder setDetails(int index, Any.Builder builderForValue)
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
repeated .google.protobuf.Any details = 3;
| Parameters |
| Name |
Description |
index |
int
|
builderForValue |
Builder
|
setField(Descriptors.FieldDescriptor field, Object value)
public Status.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setMessage(String value)
public Status.Builder setMessage(String value)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized
by the client.
string message = 2;
| Parameter |
| Name |
Description |
value |
String
The message to set.
|
setMessageBytes(ByteString value)
public Status.Builder setMessageBytes(ByteString value)
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized
by the client.
string message = 2;
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for message to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Status.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Status.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
