Packages

final case class Failure(commandId: Long = 0L, description: String = "", grpcStatusCode: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Failure] with Product with Serializable

A failure reply. If this is returned, it will be translated into a gRPC unknown error with the corresponding description if supplied.

commandId

The id of the command being replied to. Must match the input command.

description

A description of the error.

grpcStatusCode

The gRPC status code. If this failure is being sent as an action for a gRPC response, and this is non zero, then this is the code that will be used. Note that a status code of zero in gRPC means OK. Since this is a failure, zero passed here is not interpreted to mean OK, but rather indicates that no gRPC status code is explicitly specified. A status code of 2, meaning unknown error, will be sent by default. When HTTP transcoding is being used, the gRPC status code will be translated to an equivalent HTTP status code. HTTP status codes MUST NOT be passed in this field. See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a list of gRPC status codes and their meanings.

Annotations
@SerialVersionUID()
Source
Failure.scala
Linear Supertypes
Updatable[Failure], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Failure
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Failure(commandId: Long = 0L, description: String = "", grpcStatusCode: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    commandId

    The id of the command being replied to. Must match the input command.

    description

    A description of the error.

    grpcStatusCode

    The gRPC status code. If this failure is being sent as an action for a gRPC response, and this is non zero, then this is the code that will be used. Note that a status code of zero in gRPC means OK. Since this is a failure, zero passed here is not interpreted to mean OK, but rather indicates that no gRPC status code is explicitly specified. A status code of 2, meaning unknown error, will be sent by default. When HTTP transcoding is being used, the gRPC status code will be translated to an equivalent HTTP status code. HTTP status codes MUST NOT be passed in this field. See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a list of gRPC status codes and their meanings.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Failure toany2stringadd[Failure] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Failure, B)
    Implicit
    This member is added by an implicit conversion from Failure toArrowAssoc[Failure] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val commandId: Long
  9. def companion: Failure.type
    Definition Classes
    Failure → GeneratedMessage
  10. val description: String
  11. def discardUnknownFields: Failure
  12. def ensuring(cond: (Failure) => Boolean, msg: => Any): Failure
    Implicit
    This member is added by an implicit conversion from Failure toEnsuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Failure) => Boolean): Failure
    Implicit
    This member is added by an implicit conversion from Failure toEnsuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Failure
    Implicit
    This member is added by an implicit conversion from Failure toEnsuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Failure
    Implicit
    This member is added by an implicit conversion from Failure toEnsuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Failure → GeneratedMessage
  19. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Failure → GeneratedMessage
  20. val grpcStatusCode: Int
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def serializedSize: Int
    Definition Classes
    Failure → GeneratedMessage
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  29. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  30. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  31. def toProtoString: String
    Definition Classes
    Failure → GeneratedMessage
  32. val unknownFields: UnknownFieldSet
  33. def update(ms: (Lens[Failure, Failure]) => Mutation[Failure]*): Failure
    Definition Classes
    Updatable
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. def withCommandId(__v: Long): Failure
  38. def withDescription(__v: String): Failure
  39. def withGrpcStatusCode(__v: Int): Failure
  40. def withUnknownFields(__v: UnknownFieldSet): Failure
  41. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  42. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Failure → GeneratedMessage
  43. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Failure toStringFormat[Failure] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Failure, B)
    Implicit
    This member is added by an implicit conversion from Failure toArrowAssoc[Failure] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Updatable[Failure]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFailure to any2stringadd[Failure]

Inherited by implicit conversion StringFormat fromFailure to StringFormat[Failure]

Inherited by implicit conversion Ensuring fromFailure to Ensuring[Failure]

Inherited by implicit conversion ArrowAssoc fromFailure to ArrowAssoc[Failure]

Ungrouped