sec-fs2/com.google.rpc/Status

Status

final case class Status(code: Code, message: String, details: Option[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 parameters:
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
Source:
Status.scala
trait Updatable[Status]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def companion: Status.type
def getDetails: Any
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override def serializedSize: Int
Definition Classes
GeneratedMessage
Source:
Status.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Returns:

human-readable representation of this message.

Source:
Status.scala
def withCode(`__v`: Code): Status
def withDetails(`__v`: Any): Status
def withUnknownFields(`__v`: UnknownFieldSet): Status
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Source:
Status.scala

Inherited methods

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

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

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

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage
Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[Status, Status] => () => Status*): A
Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit
Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
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
Source:
GeneratedMessageCompanion.scala