Skip to main content

@terascope/job-components / index / JobConfig

Interface: JobConfig

Extends

Properties

_context

_context: "job"

Source

packages/types/dist/src/teraslice.d.ts:58


_created

_created: string | Date

Source

packages/types/dist/src/teraslice.d.ts:59


_deleted?

optional _deleted: boolean

Source

packages/types/dist/src/teraslice.d.ts:61


_deleted_on?

optional _deleted_on: string | Date

Source

packages/types/dist/src/teraslice.d.ts:62


_updated

_updated: string | Date

Source

packages/types/dist/src/teraslice.d.ts:60


active

active: boolean

Inherited from

ValidatedJobConfig.active

Source

packages/types/dist/src/teraslice.d.ts:219


analytics

analytics: boolean

Inherited from

ValidatedJobConfig.analytics

Source

packages/types/dist/src/teraslice.d.ts:220


apis

apis: APIConfig[]

Inherited from

ValidatedJobConfig.apis

Source

packages/types/dist/src/teraslice.d.ts:228


assetIds?

optional assetIds: string[]

This may not exist until ran in an execution

Inherited from

ValidatedJobConfig.assetIds

Source

packages/types/dist/src/teraslice.d.ts:223


assets

assets: string[]

Inherited from

ValidatedJobConfig.assets

Source

packages/types/dist/src/teraslice.d.ts:221


autorecover?

optional autorecover: boolean

Inherited from

ValidatedJobConfig.autorecover

Source

packages/types/dist/src/teraslice.d.ts:224


cpu?

optional cpu: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.cpu

Source

packages/types/dist/src/teraslice.d.ts:246


cpu_execution_controller?

optional cpu_execution_controller: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.cpu_execution_controller

Source

packages/types/dist/src/teraslice.d.ts:248


env_vars

env_vars: object

Index signature

[key: string]: string

Inherited from

ValidatedJobConfig.env_vars

Source

packages/types/dist/src/teraslice.d.ts:232


ephemeral_storage?

optional ephemeral_storage: boolean

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.ephemeral_storage

Source

packages/types/dist/src/teraslice.d.ts:250


ex?

optional ex: any

Source

packages/types/dist/src/teraslice.d.ts:63


external_ports?

optional external_ports: (number | ExternalPort)[]

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.external_ports

Source

packages/types/dist/src/teraslice.d.ts:252


job_id

job_id: string

Source

packages/types/dist/src/teraslice.d.ts:57


kubernetes_image?

optional kubernetes_image: string

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.kubernetes_image

Source

packages/types/dist/src/teraslice.d.ts:270


labels?

optional labels: object

This will only be available in the context of k8s

Index signature

[key: string]: string

Inherited from

ValidatedJobConfig.labels

Source

packages/types/dist/src/teraslice.d.ts:240


lifecycle

lifecycle: LifeCycle

Inherited from

ValidatedJobConfig.lifecycle

Source

packages/types/dist/src/teraslice.d.ts:225


log_level?

optional log_level: string

Inherited from

ValidatedJobConfig.log_level

Source

packages/types/dist/src/teraslice.d.ts:235


max_retries

max_retries: number

Inherited from

ValidatedJobConfig.max_retries

Source

packages/types/dist/src/teraslice.d.ts:226


memory?

optional memory: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.memory

Source

packages/types/dist/src/teraslice.d.ts:254


memory_execution_controller?

optional memory_execution_controller: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.memory_execution_controller

Source

packages/types/dist/src/teraslice.d.ts:256


name

name: string

Inherited from

ValidatedJobConfig.name

Source

packages/types/dist/src/teraslice.d.ts:227


operations

operations: OpConfig[]

Inherited from

ValidatedJobConfig.operations

Source

packages/types/dist/src/teraslice.d.ts:229


performance_metrics?

optional performance_metrics: boolean

Inherited from

ValidatedJobConfig.performance_metrics

Source

packages/types/dist/src/teraslice.d.ts:231


pod_spec_override?

optional pod_spec_override: Record<string, any>

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.pod_spec_override

Source

packages/types/dist/src/teraslice.d.ts:258


probation_window

probation_window: number

Inherited from

ValidatedJobConfig.probation_window

Source

packages/types/dist/src/teraslice.d.ts:230


prom_metrics_add_default?

optional prom_metrics_add_default: boolean

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.prom_metrics_add_default

Source

packages/types/dist/src/teraslice.d.ts:276


prom_metrics_enabled?

optional prom_metrics_enabled: boolean

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.prom_metrics_enabled

Source

packages/types/dist/src/teraslice.d.ts:272


prom_metrics_port?

optional prom_metrics_port: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.prom_metrics_port

Source

packages/types/dist/src/teraslice.d.ts:274


resources_limits_cpu?

optional resources_limits_cpu: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.resources_limits_cpu

Source

packages/types/dist/src/teraslice.d.ts:264


resources_limits_memory?

optional resources_limits_memory: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.resources_limits_memory

Source

packages/types/dist/src/teraslice.d.ts:266


resources_requests_cpu?

optional resources_requests_cpu: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.resources_requests_cpu

Source

packages/types/dist/src/teraslice.d.ts:260


resources_requests_memory?

optional resources_requests_memory: number

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.resources_requests_memory

Source

packages/types/dist/src/teraslice.d.ts:262


slicers

slicers: number

Inherited from

ValidatedJobConfig.slicers

Source

packages/types/dist/src/teraslice.d.ts:236


stateful?

optional stateful: boolean

Inherited from

ValidatedJobConfig.stateful

Source

packages/types/dist/src/teraslice.d.ts:238


targets?

optional targets: Targets[]

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.targets

Source

packages/types/dist/src/teraslice.d.ts:244


volumes?

optional volumes: Volume[]

This will only be available in the context of k8s

Inherited from

ValidatedJobConfig.volumes

Source

packages/types/dist/src/teraslice.d.ts:268


workers

workers: number

Inherited from

ValidatedJobConfig.workers

Source

packages/types/dist/src/teraslice.d.ts:237