Object

com.snowplowanalytics.iglu.client.validation

ValidatableJsonMethods

Related Doc: package validation

Permalink

object ValidatableJsonMethods extends Validatable[JsonNode]

Linear Supertypes
Validatable[JsonNode], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidatableJsonMethods
  2. Validatable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class ValidatableOps extends AnyRef

    Permalink

    Operations available as postfix-ops WARNING: this cannot be used for two ASTs with one import

    Operations available as postfix-ops WARNING: this cannot be used for two ASTs with one import

    Definition Classes
    Validatable

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. def validate(instance: JsonNode, dataOnly: Boolean = false)(implicit resolver: Resolver): ValidatedNel[JsonNode]

    Permalink

    Validates a self-describing JSON against its specified JSON Schema.

    Validates a self-describing JSON against its specified JSON Schema.

    IMPORTANT: currently the exact version of the JSON Schema (i.e. MODEL-REVISION-ADDITION) must be resolvable thru Iglu.

    instance

    The self-describing JSON to validate

    dataOnly

    Whether the returned JsonNode should be the data only, or the whole JSON (schema + data)

    returns

    either Success boxing the JsonNode or a Failure boxing a NonEmptyList of ProcessingMessages

    Definition Classes
    ValidatableJsonMethodsValidatable
  18. def validateAgainstSchema(instance: JsonNode, schema: JsonNode)(implicit resolver: Resolver): ValidatedNel[JsonNode]

    Permalink

    Validates a JSON against a given JSON Schema.

    Validates a JSON against a given JSON Schema. On Success, simply passes through the original JSON. On Failure, return a NonEmptyList of failure messages.

    instance

    The JSON to validate

    schema

    The JSON Schema to validate the JSON against

    returns

    either Success boxing the JsonNode, or a Failure boxing a NonEmptyList of ProcessingMessages

    Definition Classes
    ValidatableJsonMethodsValidatable
  19. def validateAndIdentifySchema(instance: JsonNode, dataOnly: Boolean = false)(implicit resolver: Resolver): ValidatedNel[JsonSchemaPair]

    Permalink

    The same as validate(), but on Success returns a tuple containing the SchemaKey as well as the JsonNode.

    The same as validate(), but on Success returns a tuple containing the SchemaKey as well as the JsonNode.

    IMPORTANT: currently the exact version of the JSON Schema (i.e. MODEL-REVISION-ADDITION) must be resolvable thru Iglu.

    instance

    The self-describing JSON to validate

    dataOnly

    Whether the returned JsonNode should be the data only, or the whole JSON (schema + data)

    returns

    either Success boxing a Tuple2 of the JSON's SchemaKey plus its JsonNode, or a Failure boxing a NonEmptyList of ProcessingMessages

    Definition Classes
    ValidatableJsonMethodsValidatable
  20. def verifySchemaAndValidate(instance: JsonNode, schemaCriterion: SchemaCriterion, dataOnly: Boolean = false)(implicit resolver: Resolver): ValidatedNel[JsonNode]

    Permalink

    Verify that this JSON is of the expected schema, then validate it against the schema.

    Verify that this JSON is of the expected schema, then validate it against the schema.

    IMPORTANT: currently the exact version of the JSON Schema (i.e. MODEL-REVISION-ADDITION) must be resolvable thru Iglu.

    instance

    The self-describing JSON to verify and validate

    schemaCriterion

    Identifying the schema we believe this JSON is described by

    dataOnly

    Whether the returned JsonNode should be the data only, or the whole JSON (schema + data)

    returns

    either Success boxing the JsonNode or a Failure boxing a NonEmptyList of ProcessingMessages

    Definition Classes
    ValidatableJsonMethodsValidatable
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Validatable[JsonNode]

Inherited from AnyRef

Inherited from Any

Ungrouped