Status class final

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.

Inheritance
Available extensions

Constructors

Status({int code = 0, String message = '', List<Any> details = const []})
Status.fromJson(Object? j)
factory

Properties

code → int
The status code, which should be an enum value of google.rpc.Code.
final
details → List<Any>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
final
detailsAsMessages → List<ProtoMessage>

Available on Status, provided by the StatusExtension extension

Return the list of details with the list elements converted to ProtoMessage instances.
no setter
errorInfo → ErrorInfo?

Available on Status, provided by the StatusExtension extension

A utility method to return any ErrorInfo instance from the details list.
no setter
hashCode → int
The hash code for this object.
no setterinherited
localizedMessage → LocalizedMessage?

Available on Status, provided by the StatusExtension extension

A utility method to return any LocalizedMessage instance from the details list.
no setter
message → String
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.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String