sec-fs2
0.40.0
API
Generated with
sec-fs2/com/com.google.rpc

com.google.rpc

package com.google.rpc

Members list

Type members

Classlikes

sealed abstract class Code(val value: Int) extends GeneratedEnum

The canonical error codes for gRPC APIs.

The canonical error codes for gRPC APIs.

Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer OUT_OF_RANGE over FAILED_PRECONDITION if both codes apply. Similarly prefer NOT_FOUND or ALREADY_EXISTS over FAILED_PRECONDITION.

Attributes

Companion
object
Source
Code.scala
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ABORTED.type
object ALREADY_EXISTS.type
object CANCELLED.type
object DATA_LOSS.type
object DEADLINE_EXCEEDED.type
object FAILED_PRECONDITION.type
object INTERNAL.type
object INVALID_ARGUMENT.type
object NOT_FOUND.type
object OK.type
object OUT_OF_RANGE.type
object PERMISSION_DENIED.type
object RESOURCE_EXHAUSTED.type
trait Recognized
object UNAUTHENTICATED.type
object UNAVAILABLE.type
object UNIMPLEMENTED.type
object UNKNOWN.type
class Unrecognized
Show all
object Code extends GeneratedEnumCompanion[Code]

Attributes

Companion
class
Source
Code.scala
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[Code]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Code.type
object CodeProto extends GeneratedFileObject

Attributes

Source
CodeProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
CodeProto.type
final case class Status(code: Code, message: String, details: Option[Any], unknownFields: UnknownFieldSet) extends GeneratedMessage

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.

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.

Attributes

Companion
object
Source
Status.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Status extends GeneratedMessageCompanion[Status]

Attributes

Companion
class
Source
Status.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Status]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Status.type
object StatusProto extends GeneratedFileObject

Attributes

Source
StatusProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
Generated with