Status

@SerialVersionUID(0L) final case
class Status(code: Int, message: String, details: Seq[Any], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Status]

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.

Value Params
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

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.

Companion
object
trait Updatable[Status]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addAllDetails(`__vs`: Iterable[Any]): Status
def addDetails(`__vs`: Any*): Status
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
Definition Classes
GeneratedMessage
def toProtoString: String
def withCode(`__v`: Int): Status
def withDetails(`__v`: Seq[Any]): Status
def withMessage(`__v`: String): Status
def withUnknownFields(`__v`: UnknownFieldSet): Status
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

Serializes the messgae and returns a byte array containing its raw bytes

Serializes the messgae and returns a byte array containing its raw bytes

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
def update(ms: Lens[Status, Status] => () => Status*): Status
Inherited from
Updatable
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage