mise API - v0.0.0
    Preparing search index...

    Interface PluginInstance

    Plugin instance item resource object representing a plugin instance.

    interface PluginInstance {
        auth: Object;
        collection: Object | null;
        contentType: string;
        url: string;
        get data(): Object | null;
        get isEmpty(): boolean;
        _delete(timeout?: number): Promise<any>;
        _getResource(
            linkRelation: string,
            ResourceClass: Object,
            searchParams?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<Object>;
        _put(
            data: Object,
            uploadFileObj: Object | null,
            timeout?: number,
        ): Promise<PluginInstance>;
        clone(): Resource;
        delete(timeout?: number): Promise<any>;
        get(timeout?: number): Promise<PluginInstance>;
        getComputeResource(timeout?: number): Promise<ComputeResource>;
        getDescendantPluginInstances(
            params?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<PluginInstanceDescendantList>;
        getFeed(timeout?: number): Promise<Feed | null>;
        getOutputFolder(timeout?: number): Promise<FileBrowserFolder>;
        getParameters(
            params?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<PluginInstanceParameterList>;
        getPlugin(timeout?: number): Promise<Plugin>;
        getPreviousPluginInstance(timeout?: number): Promise<PluginInstance | null>;
        getPUTParameters(): string[] | null;
        getSplits(
            params?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<PluginInstanceSplitList>;
        getWorkflow(timeout?: number): Promise<Workflow | null>;
        put(
            data: { status?: string; title?: string },
            timeout?: number,
        ): Promise<PluginInstance>;
    }

    Hierarchy (View Summary)

    Index
    auth collection contentType url
    data isEmpty
    _delete _getResource _put clone delete get getComputeResource getDescendantPluginInstances getFeed getOutputFolder getParameters getPlugin getPreviousPluginInstance getPUTParameters getSplits getWorkflow put
    auth: Object
    collection: Object | null
    contentType: string
    url: string
    • get data(): Object | null

      Get the item's data object (REST API descriptors).

      Returns Object | null

    • get isEmpty(): boolean

      Return true if the resource object contains any data.

      Returns boolean

    _delete

    • _delete(timeout?: number): Promise<any>

      Internal helper method to make a DELETE request to this item resource through the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<any>

      • JS Promise

    _getResource

    • _getResource(
          linkRelation: string,
          ResourceClass: Object,
          searchParams?: { limit?: number; offset?: number },
          timeout?: number,
      ): Promise<Object>

      Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.

      Parameters

      • linkRelation: string
      • ResourceClass: Object
      • OptionalsearchParams: { limit?: number; offset?: number }

        search parameters object which is resource-specific

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<Object>

      • JS Promise, resolves to a ResourceClass object

      throw error if this item resource has not yet been fetched from the REST API

      throw error when the link relation is not found

    _put

    • _put(
          data: Object,
          uploadFileObj: Object | null,
          timeout?: number,
      ): Promise<PluginInstance>

      Internal helper method to make a PUT request to this item resource through the REST API.

      Parameters

      • data: Object

        request JSON data object

      • uploadFileObj: Object | null

        custom file object

        • Object
          • fname

            file blob

        • null
      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstance>

      • JS Promise, resolves to this object

    • Make a deep copy clone of this object resource.

      Returns Resource

      • clone object

    • Make a DELETE request to delete this plugin instance resource through the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<any>

      • JS Promise

    • Fetch this item resource from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstance>

      • JS Promise, resolves to this object

    • Fetch the compute resource associated to this plugin instance item from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<ComputeResource>

      • JS Promise, resolves to a ComputeResource object

    • Fetch a list of plugin instances that are descendents of this plugin instance from the REST API.

      Parameters

      • Optionalparams: { limit?: number; offset?: number }

        page parameters

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstanceDescendantList>

      • JS Promise, resolves to a PluginInstanceDescendantList object

    • Fetch the feed associated to this plugin instance from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<Feed | null>

      • JS Promise, resolves to a Feed object or null

    • Fetch the output folder associated to this plugin instance item from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileBrowserFolder>

      • JS Promise, resolves to a FileBrowserFolder object

    • Fetch a list of plugin instance parameters associated to this plugin instance from the REST API.

      Parameters

      • Optionalparams: { limit?: number; offset?: number }

        page parameters

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstanceParameterList>

      • JS Promise, resolves to a PluginInstanceParameterList object

    • Fetch the plugin associated to this plugin instance item from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<Plugin>

      • JS Promise, resolves to a Plugin object

    • Fetch the parent plugin instance of this plugin instance from the REST API (only for 'ds' and 'ts' plugins, 'fs' plugins pass null to the resultant Promise).

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstance | null>

      • JS Promise, resolves to a PluginInstance object or null

    • Get an array of parameter names that can be used as properties of the data object in PUT requests.

      Returns string[] | null

      • array of PUT data property name or null if this list resource's data has not been fetched from the API yet or it doesn't support PUT requests.

    • Fetch a list of output directory splits applied to this plugin instance from the REST API.

      Parameters

      • Optionalparams: { limit?: number; offset?: number }

        page parameters

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstanceSplitList>

      • JS Promise, resolves to a PluginInstanceSplitList object

    • Fetch the workflow (if any) that created this plugin instance from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<Workflow | null>

      • JS Promise, resolves to a Workflow object or null

    • Make a PUT request to modify this plugin instance resource through the REST API.

      Parameters

      • data: { status?: string; title?: string }

        request JSON data object

        • Optionalstatus?: string

          execution status of the plugin instance (eg. cancelled)

        • Optionaltitle?: string

          title of the plugin instance

      • Optionaltimeout: number

        request timeout

      Returns Promise<PluginInstance>

      • JS Promise, resolves to this object

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods