Packages

final case class Status(code: Code = com.google.rpc.Code.OK, message: String = "", details: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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). 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).

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()
Source
Status.scala
Linear Supertypes
Updatable[Status], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Status
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Status(code: Code = com.google.rpc.Code.OK, message: String = "", details: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearDetails: Status
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val code: Code
  8. def companion: Status.type
    Definition Classes
    Status → GeneratedMessage
  9. val details: Option[Any]
  10. def discardUnknownFields: Status
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getDetails: Any
  15. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Status → GeneratedMessage
  16. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Status → GeneratedMessage
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val message: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  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(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. def withCode(__v: Code): Status
  35. def withDetails(__v: 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 Updatable[Status]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped