ISnapshotFetchOptions Interface

Snapshot fetch options which are used to communicate different things to the driver when fetching the snapshot.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ISnapshotFetchOptions

Properties

Property	Alerts	Modifiers	Type	Description
cacheSnapshot	Beta	optional	boolean	Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is set to true. If undefined, then it is upto the driver, to cache it or not.
fetchSource	Beta	optional	FetchSource	Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from network and cache or specify FetchSource.noCache to just fetch from network.
loadingGroupIds	Beta	optional	string[]	List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for content with groupIds or not. Don't provide anything here for fetching content for initial container boot.
scenarioName	Beta	optional	string	Indicates scenario in which the snapshot is fetched. It is a free form string mostly used for telemetry purposes.
versionId	Beta	optional	string	Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the container, so specifying version is not necessary for storage services.

Property Details

cacheSnapshot

Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is set to true. If undefined, then it is upto the driver, to cache it or not.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

cacheSnapshot?: boolean;

Type: boolean

fetchSource

Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from network and cache or specify FetchSource.noCache to just fetch from network.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

fetchSource?: FetchSource;

Type: FetchSource

loadingGroupIds

List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for content with groupIds or not. Don't provide anything here for fetching content for initial container boot.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

loadingGroupIds?: string[];

Type: string[]

scenarioName

Indicates scenario in which the snapshot is fetched. It is a free form string mostly used for telemetry purposes.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

scenarioName?: string;

Type: string

versionId

Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the container, so specifying version is not necessary for storage services.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

versionId?: string;

Type: string