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

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

# Interface: SiteArchiveImportSplitOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:403](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L403)

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

## Properties

### archiveName?

> `optional` **archiveName**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:415](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L415)

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:411](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L411)

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:409](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L409)

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:419](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L419)

Called before each part begins uploading.

#### Parameters

##### info

[`SplitImportPartInfo`](SplitImportPartInfo.md)

#### Returns

`void`

***

### onPlan()?

> `optional` **onPlan**: (`plan`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:417](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L417)

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

#### Parameters

##### plan

[`SplitImportPlanInfo`](SplitImportPlanInfo.md)

#### Returns

`void`

***

### waitOptions?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:413](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1dedfc1ffefa01c3d5bff62c8f7e7e682a1a91cd/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L413)

Wait options applied to each part's import job.