Interface DcaasAPI

interface DcaasAPI {
    clearCache: () => void;
    dataConnectionsDcaa: (
        connectionId: string,
        options?: ApiCallOptions,
    ) => Promise<DataConnectionsDcaaHttpResponse>;
    dataConnectionsDcaas: (
        body: CreateConnectionReq,
        options?: ApiCallOptions,
    ) => Promise<DataConnectionsDcaasHttpResponse>;
    dataConnectionsDcaasApiSpecs: (
        query: { dataSourceId: string },
        options?: ApiCallOptions,
    ) => Promise<DataConnectionsDcaasApiSpecsHttpResponse>;
}
Index

Properties

clearCache dataConnectionsDcaa dataConnectionsDcaas dataConnectionsDcaasApiSpecs

Properties

clearCache: () => void

Clears the cache for dcaas api requests.

Type declaration

    • (): void

    • Clears the cache for dcaas api requests.

      Returns void

dataConnectionsDcaa: (
    connectionId: string,
    options?: ApiCallOptions,
) => Promise<DataConnectionsDcaaHttpResponse>

Type declaration

DEPRECATED. Use GET /v1/data-connections/{connectionId}?parseConnection=true to get connection with parsed connection properties.

ID of the connection

DataConnectionsDcaaHttpError

dataConnectionsDcaas: (
    body: CreateConnectionReq,
    options?: ApiCallOptions,
) => Promise<DataConnectionsDcaasHttpResponse>

Type declaration

DEPRECATED. Use POST /v1/data-connections to create connection.

Param: body

an object with the body content

DataConnectionsDcaasHttpError

dataConnectionsDcaasApiSpecs: (
    query: { dataSourceId: string },
    options?: ApiCallOptions,
) => Promise<DataConnectionsDcaasApiSpecsHttpResponse>

Type declaration

DEPRECATED. Use GET /v1/data-sources/{dataSourceId}/api-specs to return 'connectionProperties' for a given datasource.

an object with query parameters

DataConnectionsDcaasApiSpecsHttpError

Settings

Member Visibility

On This Page

Properties