case class DataverseMessage[D](status: String, data: Option[D], message: Option[String]) extends Product with Serializable
A JSON response message sent by Dataverse. The message may contain payload object (for example dataset information when this was requested).
This can be retrieved from the data field. It may also contain an informational message. That can be retrieved from the message field.
Sometimes the informational message is packaged in the data field. In these cases the payload type will be DataMessage.
- D
the expected type of payload data
- status
current status, usually OK or ERROR
- data
payload of the response; in case of an ERROR: the error message
- message
a message from Dataverse, maybe informational or a warning
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- DataverseMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
DataverseMessage(status: String, data: Option[D], message: Option[String])
- status
current status, usually OK or ERROR
- data
payload of the response; in case of an ERROR: the error message
- message
a message from Dataverse, maybe informational or a warning
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val data: Option[D]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val message: Option[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val status: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()