@salesforce/b2c-tooling-sdk / operations/jobs / SiteArchiveImportSplitOptions

Interface: SiteArchiveImportSplitOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:455

Options for siteArchiveImportSplit.

Properties

archiveName?

optional archiveName: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:467

Base archive name; parts are suffixed (e.g. <name>-core, <name>-assets-1).

keepArchive?

optional keepArchive: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:463

Keep archive parts on the instance after import (default: false).

maxBytes?

optional maxBytes: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:461

Maximum size in bytes for each archive part (default: 190 MiB). Parts are packed by estimated compressed size to stay under this ceiling; the instance import limit is the constraint this works around.

onPart()?

optional onPart: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:471

Called before each part begins uploading.

Parameters

info

SplitImportPartInfo

Returns

void

onPlan()?

optional onPlan: (plan) => void

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:469

Called when the overall plan is known, before any upload.

Parameters

plan

SplitImportPlanInfo

Returns

void

waitOptions?

optional waitOptions: WaitForJobOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:465

Wait options applied to each part's import job.