---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/jobs](../index.md) / SiteArchiveImportSetOptions

# Interface: SiteArchiveImportSetOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:140](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L140)

Options for [siteArchiveImportSet](../functions/siteArchiveImportSet.md).

## Properties

### breakLock?

> `optional` **breakLock**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:162](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L162)

Immediately remove an existing lock before attempting to acquire it.

***

### cartridgeRoot?

> `optional` **cartridgeRoot**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:150](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L150)

Root directory used to discover cartridges. Defaults to the current working directory.

***

### dryRun?

> `optional` **dryRun**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:144](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L144)

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

***

### excludeDirectories?

> `optional` **excludeDirectories**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:152](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L152)

Directory paths to exclude recursively, resolved relative to `cartridgeRoot`.

***

### heartbeatIntervalSeconds?

> `optional` **heartbeatIntervalSeconds**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:160](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L160)

Lock heartbeat interval. Defaults to 30 seconds.

***

### importArchive()?

> `optional` **importArchive**: (`instance`, `target`, `options`) => `Promise`\<[`SiteArchiveImportResult`](SiteArchiveImportResult.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:173](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L173)

Archive importer override. Defaults to [siteArchiveImport](../functions/siteArchiveImport.md).
Useful when embedding the operation with a custom import policy.

#### Parameters

##### instance

[`B2CInstance`](../../../instance/classes/B2CInstance.md)

##### target

`string`

##### options

[`SiteArchiveImportOptions`](SiteArchiveImportOptions.md)

#### Returns

`Promise`\<[`SiteArchiveImportResult`](SiteArchiveImportResult.md)\>

***

### includeCartridgeMetadata?

> `optional` **includeCartridgeMetadata**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:148](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L148)

Include items from `metadata/` directories in discovered cartridges. Defaults to true.

***

### keepArchive?

> `optional` **keepArchive**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:146](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L146)

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:158](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L158)

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:168](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L168)

Receives planning, locking, and item progress events. The operation itself does not log or write output.

#### Parameters

##### event

[`ImportSetEvent`](../type-aliases/ImportSetEvent.md)

#### Returns

`void`

***

### owner?

> `optional` **owner**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:164](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L164)

Optional owner label stored in lock metadata.

***

### setId?

> `optional` **setId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:142](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L142)

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:179](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L179)

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:156](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L156)

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:154](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L154)

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

***

### waitOptions?

> `optional` **waitOptions**: [`WaitForJobOptions`](WaitForJobOptions.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:166](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/b0472c439ca6570be5c7809783a46327d7493694/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L166)

Wait options forwarded to each site archive import.