@terascope/job-components / builtin/collect/schema / default

Class: default

Defined in: job-components/src/builtin/collect/schema.ts:4

A base class for supporting convict style "Schema" definitions

Extends

• default<CollectConfig>

Constructors

Constructor

new default(context, opType?): Schema

Defined in: job-components/src/operations/base-schema.ts:17

Parameters

Parameter	Type	Default value
context	Context	undefined
opType	OpType	'operation'

Returns

Schema

Inherited from

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
context	protected	Context	default.context	job-components/src/operations/core/schema-core.ts:9
opType	readonly	OpType	default.opType	job-components/src/operations/core/schema-core.ts:10
schema	public	Terafoundation.Schema<S>	default.schema	job-components/src/operations/base-schema.ts:15

Methods

build()

build(): Record<string, any>

Defined in: job-components/src/builtin/collect/schema.ts:5

Returns

Record<string, any>

Overrides

default.build

---

validate()

Call Signature

validate(inputConfig): object

Defined in: job-components/src/operations/base-schema.ts:22

Parameters

Parameter	Type
inputConfig	Record<string, any>

Returns

object

config

config: APIConfig & CollectConfig

warnings

warnings: JobWarning[]

Inherited from

default.validate

Call Signature

validate(inputConfig): object

Defined in: job-components/src/operations/base-schema.ts:25

Parameters

Parameter	Type
inputConfig	Record<string, any>

Returns

object

config

config: OpConfig & CollectConfig

warnings

warnings: JobWarning[]

Inherited from

default.validate

---

validateJob()

validateJob(_job): void

Defined in: job-components/src/operations/base-schema.ts:37

Parameters

Parameter	Type
_job	ValidatedJobConfig

Returns

void

Inherited from

default.validateJob

---

type()

static type(): string

Defined in: job-components/src/operations/base-schema.ts:41

Returns

string

Inherited from

default.type