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

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

## Properties

### breakLock?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:96](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L96)

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

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

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

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)\>

***

### keepArchive?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:86](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L86)

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

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

Receives planning, locking, and item progress events.

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

Optional owner label stored in lock metadata.

***

### setId?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts:82](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/import-set.ts#L82)

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

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

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

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

Wait options forwarded to each site archive import.