Class Status (2.38.0)
Version 2.38.0keyboard_arrow_down
public final class Status extends GeneratedMessageV3 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.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CODE_FIELD_NUMBER
public static final int CODE_FIELD_NUMBER
Field Value
Type Description
int
DETAILS_FIELD_NUMBER
public static final int DETAILS_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 Status getDefaultInstance ()
Returns
Type Description
Status
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Status . Builder newBuilder ()
newBuilder(Status prototype)
public static Status . Builder newBuilder ( Status prototype )
Parameter
Name Description
prototypeStatus
public static Status parseDelimitedFrom ( InputStream input )
Returns
Type Description
Status
public static Status parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
parseFrom(byte[] data)
public static Status parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Status
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Status parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
parseFrom(ByteString data)
public static Status parseFrom ( ByteString data )
Returns
Type Description
Status
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Status parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
public static Status parseFrom ( CodedInputStream input )
Returns
Type Description
Status
public static Status parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
public static Status parseFrom ( InputStream input )
Returns
Type Description
Status
public static Status parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
parseFrom(ByteBuffer data)
public static Status parseFrom ( ByteBuffer data )
Returns
Type Description
Status
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Status parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Status
parser()
public static Parser<Status> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
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
indexint
Returns
Type Description
Any
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
indexint
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.
getParserForType()
public Parser<Status> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Status . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Status . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Status . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
