streamingValidation

streamingValidation

Contains constants and functions for a Streaming Validation.

The structure for a Streaming Validation is as follows:

{
  payload: {
    name: <string>,
    messages: <array>,
    context: <object>,
  },
  type: 'service'
  vendor: 'com.adobe.streaming.validation'
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Streaming Validation objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Streaming Validation

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
name string

The name of the event.
Path is payload.name.
messages string

Messages received from the service.
Path is payload.messages.
context string

Additional context provided by the service.
Path is payload.context.
rootType string

The type of event.
Path is type.
vendor string
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Streaming Validation.

Path is type.

Source:

(static, constant) VENDOR

The value for vendor for a Streaming Validation.

Path is vendor.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getContext(source) → {object}

Returns the context from the Streaming Validation. This is the additional context provided by the service.

Path is payload,context.

Parameters:
Name Type Description
source object

The Streaming Validation instance
Source:

(static) getContextKey(…path, source) → {*}

Returns the data using the specified path from the context of the Streaming Validation.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Streaming Validation instance
Source:

(static) getMessages(source) → {Array}

Returns the messages from the Streaming Validation. This is the messages received from the service.

Path is payload,messages.

Parameters:
Name Type Description
source object

The Streaming Validation instance
Source:

(static) getName(source) → {string}

Returns the name from the Streaming Validation. This is the the name of the event.

Path is payload,name.

Parameters:
Name Type Description
source object

The Streaming Validation instance
Source:

(static) getVendor(source) → {string}

Returns the vendor from the Streaming Validation. This is the .

Path is vendor.

Parameters:
Name Type Description
source object

The Streaming Validation instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Streaming Validation event.

Parameters:
Name Type Description
source object

The Streaming Validation instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Streaming Validation with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Streaming Validation with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: