case class FallibleFieldsSpec(fields: Map[String, Set[String]], default: Boolean = true) extends FieldsSpec with Product with Serializable
Used to track sparse fieldsets requested by the caller. See https://jsonapi.org/format/#fetching-sparse-fieldsets
Note that by specifying field names, you make it possible for encoding to fail due to an unrecognized field name. Contrast this with the InfallibleFieldsSpecs.
- default
should a field be included if its resourceType is not specified in the map?
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- FallibleFieldsSpec
- Serializable
- Product
- Equals
- FieldsSpec
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new FallibleFieldsSpec(fields: Map[String, Set[String]], default: Boolean = true)
- default
should a field be included if its resourceType is not specified in the map?
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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val default: Boolean
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def explicitFields(resourceType: String): Set[String]
- Definition Classes
- FallibleFieldsSpec → FieldsSpec
- val fields: Map[String, Set[String]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def includeField(resourceType: String, field: String): Boolean
- Definition Classes
- FallibleFieldsSpec → FieldsSpec
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated