final case class Status(code: Int = 0, message: String = "", details: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Status] with Product with Serializable

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). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

# Overview

The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.

# Language mapping

The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

# Other uses

The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.

- Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.

- Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.

- Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.

code

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

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.

details

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

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Status], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Status
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Status(code: Int = 0, message: String = "", details: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    code

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

    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.

    details

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllDetails(__vs: Iterable[Any]): Status
  5. def addDetails(__vs: Any*): Status
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearDetails: Status
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val code: Int
  10. def companion: Status.type
    Definition Classes
    Status → GeneratedMessage
  11. val details: Seq[Any]
  12. def discardUnknownFields: Status
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Status → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Status → GeneratedMessage
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val message: String
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def serializedSize: Int
    Definition Classes
    Status → GeneratedMessage
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  26. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  27. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  28. def toProtoString: String
    Definition Classes
    Status → GeneratedMessage
  29. val unknownFields: UnknownFieldSet
  30. def update(ms: (Lens[Status, Status]) ⇒ Mutation[Status]*): Status
    Definition Classes
    Updatable
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def withCode(__v: Int): Status
  35. def withDetails(__v: Seq[Any]): Status
  36. def withMessage(__v: String): Status
  37. def withUnknownFields(__v: UnknownFieldSet): Status
  38. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  39. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Status → GeneratedMessage
  40. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Status]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped