Skip to content
View as Markdown
View as Markdown

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

Interface: SiteArchiveImportOptions

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

Options for site archive import.

Properties

keepArchive?

optional keepArchive: boolean

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

Keep archive on instance after import (default: false)


paths?

optional paths: string[]

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

Optional list of paths or glob patterns to include in the archive when importing from a directory. Each entry may be:

  • An absolute path under the root directory
  • A path relative to the root directory
  • A glob pattern (relative to the root) — magic chars * ? [ ] { }

When omitted, the entire root directory is archived (current behavior). Entries that resolve outside the root directory throw an error. Ignored when target is a zip file, Buffer, or remote filename.


wait?

optional wait: boolean

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

Whether to wait for job completion (default: true)


waitOptions?

optional waitOptions: WaitForJobOptions

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

Wait options for job completion

Released under the Apache-2.0 License.