Membrane SDK - v0.2.1
    Preparing search index...

    Interface DataSourceInstance

    interface DataSourceInstance {
        userId: string;
        revision: string;
        user?: Customer;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        dataSource?: DataSource;
        udm?: string;
        connectionId: string;
        connection?: Connection;
        integrationId: string;
        integration?: Integration;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: DataCollectionSpec;
        isCustomized?: boolean;
        errors?: ErrorData[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        id: string;
        name: string;
        key: string;
        state?: WorkspaceElementState;
    }

    Hierarchy (View Summary)

    Index

    Properties

    userId revision user? dataSourceRevision? dataSourceId? universalDataSourceId? dataSource? udm? connectionId connection? integrationId integration? instanceKey? collectionKey? collectionParameters? defaultCollectionKey? defaultCollectionParameters? collectionSpec? isCustomized? errors? pullUpdatesIntervalSeconds? fullSyncIntervalSeconds? path? defaultPath? id name key state?

    Properties

    userId: string
    revision: string
    user?: Customer
    dataSourceRevision?: string
    dataSourceId?: string
    universalDataSourceId?: string
    dataSource?: DataSource
    udm?: string
    connectionId: string
    connection?: Connection
    integrationId: string
    integration?: Integration
    instanceKey?: string
    collectionKey?: string
    collectionParameters?: any
    defaultCollectionKey?: string
    defaultCollectionParameters?: any
    collectionSpec?: DataCollectionSpec

    Specification of the collection path is pointing to.

    isCustomized?: boolean

    Whether the data source instance was customized by the user.

    If it was customized - it won't automatically update when the underlying data changes.

    errors?: ErrorData[]
    pullUpdatesIntervalSeconds?: number
    fullSyncIntervalSeconds?: number
    path?: string
    defaultPath?: string
    id: string
    name: string
    key: string
    state?: WorkspaceElementState

    Settings

    Member Visibility

    On This Page

    Properties