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

Interface: SiteArchiveImportSetOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:80

Options for siteArchiveImportSet.

Properties

breakLock?

optional breakLock: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:96

Immediately remove an existing lock before attempting to acquire it.

---

dryRun?

optional dryRun: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:84

Plan imports without creating state, locking, importing, or writing receipts.

---

heartbeatIntervalSeconds?

optional heartbeatIntervalSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:94

Lock heartbeat interval. Defaults to 30 seconds.

---

importArchive()?

optional importArchive: (instance, target, options) => Promise<SiteArchiveImportResult>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:107

Archive importer override. Defaults to siteArchiveImport. Useful when embedding the operation with a custom import policy.

Parameters

instance

B2CInstance

target

string

options

SiteArchiveImportOptions

Returns

Promise<SiteArchiveImportResult>

---

keepArchive?

optional keepArchive: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:86

Keep uploaded archives in Impex/src/instance after each import.

---

lockPollIntervalSeconds?

optional lockPollIntervalSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:92

Poll interval while another runner owns the set lock. Defaults to 3 seconds.

---

onEvent()?

optional onEvent: (event) => void

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:102

Receives planning, locking, and item progress events.

Parameters

event

ImportSetEvent

Returns

void

---

owner?

optional owner: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:98

Optional owner label stored in lock metadata.

---

setId?

optional setId: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:82

Stable receipt and lock namespace. Defaults to migrations.

---

sleep()?

optional sleep: (milliseconds) => Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:113

Sleep implementation used while polling for a lock.

Parameters

milliseconds

number

Returns

Promise<void>

---

staleLockSeconds?

optional staleLockSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:90

Age after which a lock heartbeat is considered stale. Defaults to 1800 seconds.

---

stateRoot?

optional stateRoot: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:88

WebDAV state root. Defaults to Impex/b2c-cli/import-sets.

---

waitOptions?

optional waitOptions: WaitForJobOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:100

Wait options forwarded to each site archive import.