Interface DataSourcesAPI

interface DataSourcesAPI {
    clearCache: () => void;
    getDataSourceApiSpecs: (
        dataSourceId: string,
        options?: ApiCallOptions,
    ) => Promise<GetDataSourceApiSpecsHttpResponse>;
    getDataSourceGateways: (
        dataSourceId: string,
        query: { forceRefresh?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetDataSourceGatewaysHttpResponse>;
    getDataSources: (
        query: {
            dataSourceId?: string;
            detail?: boolean;
            includeDisabled?: boolean;
            includeui?: boolean;
        },
        options?: ApiCallOptions,
    ) => Promise<GetDataSourcesHttpResponse>;
}
Index

Properties

clearCache getDataSourceApiSpecs getDataSourceGateways getDataSources

Properties

clearCache: () => void

Clears the cache for data-sources api requests.

Type Declaration

    • (): void

    • Clears the cache for data-sources api requests.

      Returns void

getDataSourceApiSpecs: (
    dataSourceId: string,
    options?: ApiCallOptions,
) => Promise<GetDataSourceApiSpecsHttpResponse>

Get 'connectionProperties' for a given datasource

Type Declaration

getDataSourceApiSpecs(
  "rest"
)

Datasource ID

GetDataSourceApiSpecsHttpError

getDataSourceGateways: (
    dataSourceId: string,
    query: { forceRefresh?: boolean },
    options?: ApiCallOptions,
) => Promise<GetDataSourceGatewaysHttpResponse>

Get list available gateway ID's for a given datasource

Type Declaration

    • (
          dataSourceId: string,
          query: { forceRefresh?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetDataSourceGatewaysHttpResponse>

    • Get list available gateway ID's for a given datasource

      Parameters

      • dataSourceId: string

        Datasource ID

      • query: { forceRefresh?: boolean }

        an object with query parameters

        • OptionalforceRefresh?: boolean

          Force to get a refreshed list from backend. Cached list will be returned if not set or set to false.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataSourceGatewaysHttpResponse>

      getDataSourceGateways(
        "rest",
        {
          forceRefresh: true
        }
      )

      GetDataSourceGatewaysHttpError

getDataSourceGateways(
  "rest",
  {
    forceRefresh: true
  }
)

Datasource ID

an object with query parameters

GetDataSourceGatewaysHttpError

getDataSources: (
    query: {
        dataSourceId?: string;
        detail?: boolean;
        includeDisabled?: boolean;
        includeui?: boolean;
    },
    options?: ApiCallOptions,
) => Promise<GetDataSourcesHttpResponse>

Gets the list of data sources available on the node.

Type Declaration

    • (
          query: {
              dataSourceId?: string;
              detail?: boolean;
              includeDisabled?: boolean;
              includeui?: boolean;
          },
          options?: ApiCallOptions,
      ): Promise<GetDataSourcesHttpResponse>

    • Gets the list of data sources available on the node.

      Parameters

      • query: {
            dataSourceId?: string;
            detail?: boolean;
            includeDisabled?: boolean;
            includeui?: boolean;
        }

        an object with query parameters

        • OptionaldataSourceId?: string

          Filtering on datasourceID, when multiple dataSourceId are set in query, last dataSourceId will be used

        • Optionaldetail?: boolean

          Determines if provider detail is returned

        • OptionalincludeDisabled?: boolean

          When true disabled datasources are also included in the response

        • Optionalincludeui?: boolean

          Determines if UI info is returned

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataSourcesHttpResponse>

      getDataSources(
        {
          dataSourceId: "rest",
          detail: true,
          includeDisabled: true,
          includeui: true
        }
      )

      GetDataSourcesHttpError

getDataSources(
  {
    dataSourceId: "rest",
    detail: true,
    includeDisabled: true,
    includeui: true
  }
)

an object with query parameters

GetDataSourcesHttpError

Settings

Member Visibility

On This Page

Properties