eyevinn-schedule-service

Namespace

eyevinn-schedule-service

Description:
  • A modular service to automatically populate schedules for FAST Engine channels. Uses AWS Dynamo DB as database.

Author:

Methods

(async, static) createEyevinnScheduleServiceInstance(context, body) → {EyevinnScheduleService}

Description:
  • Create a new FAST Engine Schedule Service instance

Example
import { Context } from '@osaas/client-core';
import { createEyevinnScheduleServiceInstance } from '@osaas/client-services';

const ctx = new Context();
const body: EyevinnScheduleServiceConfig = { name: 'myinstance', ... };
const instance = await createEyevinnScheduleServiceInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body EyevinnScheduleServiceConfig

Service instance configuration

Returns:
  • Service instance
Type
EyevinnScheduleService

(async, static) getEyevinnScheduleServiceInstance(context, name) → {EyevinnScheduleService}

Description:
  • Get a FAST Engine Schedule Service instance

Example
import { Context } from '@osaas/client-core';
import { getEyevinnScheduleServiceInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getEyevinnScheduleServiceInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the scheduler to be retrieved

Returns:
  • Service instance
Type
EyevinnScheduleService

(async, static) removeEyevinnScheduleServiceInstance(context, name)

Description:
  • Remove a FAST Engine Schedule Service instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the scheduler to be removed