Send feedback
Class Status (1.73.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_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.cloud.compute.v1.Status
Inherited Members
com.google.protobuf.GeneratedMessageV3.makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.emptyList(java.lang.Class)
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
prototype
Status
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
data
byte []
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 parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getCode()
The status code, which should be an enum value of google.rpc.Code.
optional int32 code = 3059181;
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 = 483979842;
Parameter
Name
Description
index
int
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 = 483979842;
Returns
Type
Description
int
getDetailsList()
public List 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 = 483979842;
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 = 483979842;
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 = 483979842;
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.
optional string message = 418054151;
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.
optional string message = 418054151;
Returns
Type
Description
ByteString
The bytes for message.
getParserForType()
public Parser getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hasCode()
The status code, which should be an enum value of google.rpc.Code.
optional int32 code = 3059181;
Returns
Type
Description
boolean
Whether the code field is set.
hasMessage()
public boolean hasMessage ()
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.
optional string message = 418054151;
Returns
Type
Description
boolean
Whether the message field is set.
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
Send feedback
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-06-08 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-08 UTC."],[],[]]