Interface DataQualitiesAPI

interface DataQualitiesAPI {
    clearCache: () => void;
    getDataQualitiesComputation: (
        computationId: string,
        options?: ApiCallOptions,
    ) => Promise<GetDataQualitiesComputationHttpResponse>;
    getDataQualitiesGlobalResults: (
        query: { connectionId?: string; datasetId: string },
        options?: ApiCallOptions,
    ) => Promise<GetDataQualitiesGlobalResultsHttpResponse>;
    triggerDataQualitiesComputation: (
        body: DataQualityComputationRequest,
        options?: ApiCallOptions,
    ) => Promise<TriggerDataQualitiesComputationHttpResponse>;
}
Index

Properties

clearCache getDataQualitiesComputation getDataQualitiesGlobalResults triggerDataQualitiesComputation

Properties

clearCache: () => void

Clears the cache for data-qualities api requests.

Type declaration

    • (): void

    • Clears the cache for data-qualities api requests.

      Returns void

getDataQualitiesComputation: (
    computationId: string,
    options?: ApiCallOptions,
) => Promise<GetDataQualitiesComputationHttpResponse>

Returns the execution status of a data quality computation.

Type declaration

getDataQualitiesComputation(
  "4db06daa-3117-412e-8fb4-b29c937f9a0e"
)

The ID of the computation

GetDataQualitiesComputationHttpError

getDataQualitiesGlobalResults: (
    query: { connectionId?: string; datasetId: string },
    options?: ApiCallOptions,
) => Promise<GetDataQualitiesGlobalResultsHttpResponse>

Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.

Type declaration

    • (
          query: { connectionId?: string; datasetId: string },
          options?: ApiCallOptions,
      ): Promise<GetDataQualitiesGlobalResultsHttpResponse>

    • Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.

      Parameters

      • query: { connectionId?: string; datasetId: string }

        an object with query parameters

        • OptionalconnectionId?: string

          The connection ID

        • datasetId: string

          The ID of the dataset

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataQualitiesGlobalResultsHttpResponse>

      GetDataQualitiesGlobalResultsHttpError

an object with query parameters

GetDataQualitiesGlobalResultsHttpError

triggerDataQualitiesComputation: (
    body: DataQualityComputationRequest,
    options?: ApiCallOptions,
) => Promise<TriggerDataQualitiesComputationHttpResponse>

Triggers the computation of data quality.

Type declaration

Param: body

an object with the body content

TriggerDataQualitiesComputationHttpError

Settings

Member Visibility

On This Page

Properties