Interface LocatorFetchRequest

What a driver is asked to read back: one locator it produced.

interface LocatorFetchRequest {
    Access?: AccessArtifact;
    Configuration: Readonly<Record<string, unknown>>;
    ContentSourceID: string;
    ContextUser: UserInfo;
    Parameters: Readonly<Record<string, string>>;
    Provider: IMetadataProvider;
    Signal: AbortSignal;
    SourceURL: string;
    URL: string;
}

Index

Properties

Access? Configuration ContentSourceID ContextUser Parameters Provider Signal SourceURL URL

Properties

`Optional`Access

Access?: AccessArtifact

Configuration

Configuration: Readonly<Record<string, unknown>>

ContentSourceID

ContentSourceID: string

ContextUser

ContextUser: UserInfo

Parameters

Parameters: Readonly<Record<string, string>>

Provider

Provider: IMetadataProvider

Signal

Signal: AbortSignal

SourceURL

SourceURL: string

The source's URL column — for a file source, the root its locators must stay inside.

URL

URL: string

The locator the driver yielded as the item's URL — a path, an object key, a record id.