Skip to main content

Class: BatchJob

internal.BatchJob

Base abstract entity for all entities

Hierarchy​

Properties​

beforeInsert​

• Private beforeInsert: any

Defined in​

medusa/dist/models/batch-job.d.ts:27


canceled_at​

• Optional canceled_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:23


completed_at​

• Optional completed_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:22


confirmed_at​

• Optional confirmed_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:21


context​

• context: Record<string, unknown>

Defined in​

medusa/dist/models/batch-job.d.ts:8


created_at​

• created_at: Date

Inherited from​

SoftDeletableEntity.created_at

Defined in​

medusa/dist/interfaces/models/base-entity.d.ts:6


created_by​

• created_by: null | string

Defined in​

medusa/dist/models/batch-job.d.ts:6


created_by_user​

• created_by_user: User

Defined in​

medusa/dist/models/batch-job.d.ts:7


deleted_at​

• deleted_at: null | Date

Inherited from​

SoftDeletableEntity.deleted_at

Defined in​

medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3


dry_run​

• dry_run: boolean

Defined in​

medusa/dist/models/batch-job.d.ts:18


failed_at​

• Optional failed_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:24


id​

• id: string

Inherited from​

SoftDeletableEntity.id

Defined in​

medusa/dist/interfaces/models/base-entity.d.ts:5


pre_processed_at​

• Optional pre_processed_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:19


processing_at​

• Optional processing_at: Date

Defined in​

medusa/dist/models/batch-job.d.ts:20


result​

• result: { advancement_count?: number ; count?: number ; errors?: BatchJobResultError[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: BatchJobResultStatDescriptor[] } & Record<string, unknown>

Defined in​

medusa/dist/models/batch-job.d.ts:9


status​

• status: BatchJobStatus

Defined in​

medusa/dist/models/batch-job.d.ts:25


type​

• type: string

Defined in​

medusa/dist/models/batch-job.d.ts:5


updated_at​

• updated_at: Date

Inherited from​

SoftDeletableEntity.updated_at

Defined in​

medusa/dist/interfaces/models/base-entity.d.ts:7

Methods​

loadStatus​

▸ loadStatus(): void

Returns​

void

Defined in​

medusa/dist/models/batch-job.d.ts:26


toJSON​

▸ toJSON(): BatchJob

Returns​

BatchJob

Defined in​

medusa/dist/models/batch-job.d.ts:28

Was this section helpful?