java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.rpc.Status

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, StatusOrBuilder, java.io.Serializable

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](https://github.com/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](https://cloud.google.com/apis/design/errors).

Protobuf type google.rpc.Status

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Status.Builder`	The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field Description

static int CODE_FIELD_NUMBER

static int DETAILS_FIELD_NUMBER

static int MESSAGE_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`	Compares the specified object with this message for equality.
`int`	`getCode()`	The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
`static Status`	`getDefaultInstance()`
`Status`	`getDefaultInstanceForType()`	Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Any`	`getDetails(int index)`	A list of messages that carry the error details.
`int`	`getDetailsCount()`	A list of messages that carry the error details.
`java.util.List<Any>`	`getDetailsList()`	A list of messages that carry the error details.
`AnyOrBuilder`	`getDetailsOrBuilder(int index)`	A list of messages that carry the error details.
`java.util.List<? extends AnyOrBuilder>`	`getDetailsOrBuilderList()`	A list of messages that carry the error details.
`java.lang.String`	`getMessage()`	A developer-facing error message, which should be in English.
`ByteString`	`getMessageBytes()`	A developer-facing error message, which should be in English.
`Parser<Status>`	`getParserForType()`	Gets the parser for a message of the same type as this message.
`int`	`getSerializedSize()`	Get the number of bytes required to encode this message.
`UnknownFieldSet`	`getUnknownFields()`	Get the `UnknownFieldSet` for this message.
`int`	`hashCode()`	Returns the hash code value for this message.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`	Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()`	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static Status.Builder`	`newBuilder()`
`static Status.Builder`	`newBuilder(Status prototype)`
`Status.Builder`	`newBuilderForType()`	Constructs a new builder for a message of the same type as this message.
`protected Status.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`	TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
`protected java.lang.Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`	Creates a new instance of this message type.
`static Status`	`parseDelimitedFrom(java.io.InputStream input)`
`static Status`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Status`	`parseFrom(byte[] data)`
`static Status`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Status`	`parseFrom(ByteString data)`
`static Status`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Status`	`parseFrom(CodedInputStream input)`
`static Status`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Status`	`parseFrom(java.io.InputStream input)`
`static Status`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Status`	`parseFrom(java.nio.ByteBuffer data)`
`static Status`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Parser<Status>`	`parser()`
`Status.Builder`	`toBuilder()`	Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)`	Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

- Field Detail
  - CODE_FIELD_NUMBER
```
public static final int CODE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MESSAGE_FIELD_NUMBER
```
public static final int MESSAGE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DETAILS_FIELD_NUMBER
```
public static final int DETAILS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected java.lang.Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Description copied from class: GeneratedMessageV3
    
    Creates a new instance of this message type. Overridden in the generated code.
    
    Overrides:
    
    newInstance in class GeneratedMessageV3
  - getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class GeneratedMessageV3
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3
  - getCode
```
public int getCode()
```
    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    int32 code = 1;
    Specified by:
    
    getCode in interface StatusOrBuilder
    
    Returns:
    
    The code.
  - getMessage
```
public java.lang.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][google.rpc.Status.details] field, or localized by the client.
    string message = 2;
    Specified by:
    
    getMessage in interface StatusOrBuilder
    
    Returns:
    
    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][google.rpc.Status.details] field, or localized by the client.
    string message = 2;
    Specified by:
    
    getMessageBytes in interface StatusOrBuilder
    
    Returns:
    
    The bytes for message.
  - getDetailsList
```
public java.util.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;
    Specified by:
    
    getDetailsList in interface StatusOrBuilder
  - getDetailsOrBuilderList
```
public java.util.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;
    Specified by:
    
    getDetailsOrBuilderList in interface StatusOrBuilder
  - 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;
    Specified by:
    
    getDetailsCount in interface StatusOrBuilder
  - getDetails
```
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;
    Specified by:
    
    getDetails in interface StatusOrBuilder
  - getDetailsOrBuilder
```
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;
    Specified by:
    
    getDetailsOrBuilder in interface StatusOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3
  - writeTo
```
public void writeTo(CodedOutputStream output)
             throws java.io.IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output. This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class GeneratedMessageV3
    
    Throws:
    
    java.io.IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: MessageLite
    
    Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class GeneratedMessageV3
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: Message
    
    Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    Parameters:
    
    obj - object to be compared for equality with this message
    
    Returns:
    
    true if the specified object is equal to this message
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Message
    
    Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - parseFrom
```
public static Status parseFrom(java.nio.ByteBuffer data)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(java.nio.ByteBuffer data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(ByteString data)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(ByteString data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(byte[] data)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(byte[] data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Status parseFrom(java.io.InputStream input)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Status parseFrom(java.io.InputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Status parseDelimitedFrom(java.io.InputStream input)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Status parseDelimitedFrom(java.io.InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Status parseFrom(CodedInputStream input)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Status parseFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public Status.Builder newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static Status.Builder newBuilder()
```
  - newBuilder
```
public static Status.Builder newBuilder(Status prototype)
```
  - toBuilder
```
public Status.Builder toBuilder()
```
    Description copied from interface: MessageLite
    
    Constructs a builder initialized with the current message. Use this to derive a new message from the current one.
    
    Specified by:
    
    toBuilder in interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - newBuilderForType
```
protected Status.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
```
    Description copied from class: GeneratedMessageV3
    
    TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
    
    Specified by:
    
    newBuilderForType in class GeneratedMessageV3
  - getDefaultInstance
```
public static Status getDefaultInstance()
```
  - parser
```
public static Parser<Status> parser()
```
  - getParserForType
```
public Parser<Status> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class GeneratedMessageV3
  - getDefaultInstanceForType
```
public Status getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder

Modifier and Type	Field	Description
`static int`	`CODE_FIELD_NUMBER`
`static int`	`DETAILS_FIELD_NUMBER`
`static int`	`MESSAGE_FIELD_NUMBER`

Class Status

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageLite

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Field Detail

CODE_FIELD_NUMBER

MESSAGE_FIELD_NUMBER

DETAILS_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getCode

getMessage

getMessageBytes

getDetailsList

getDetailsOrBuilderList

getDetailsCount

getDetails

getDetailsOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType