UNPKG

@pulumi/databricks

Version:

A Pulumi package for creating and managing databricks cloud resources.

132 lines (131 loc) 5.53 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types) * * This data source can be used to fetch the list of data quality refreshes on a Unity Catalog table. * * The caller must either: * 1. be an owner of the table's parent catalog * 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema. * 3. have the following permissions: * - **USE_CATALOG** on the table's parent catalog * - **USE_SCHEMA** on the table's parent schema * - **SELECT** privilege on the table. * * > **Note** This data source can only be used with a workspace-level provider! * * ## Example Usage * * Getting a list of all data quality refresh for a given table: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as databricks from "@pulumi/databricks"; * * const _this = databricks.getTable({ * name: "my_catalog.my_schema.my_table", * }); * const all = _this.then(_this => databricks.getDataQualityRefreshes({ * objectType: "table", * objectId: _this.id, * })); * ``` */ export declare function getDataQualityRefreshes(args: GetDataQualityRefreshesArgs, opts?: pulumi.InvokeOptions): Promise<GetDataQualityRefreshesResult>; /** * A collection of arguments for invoking getDataQualityRefreshes. */ export interface GetDataQualityRefreshesArgs { /** * The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`. * * Find the `schemaId` from either: * 1. The [schemaId](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field. * * Find the `tableId` from either: * 1. The [tableId](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field */ objectId: string; /** * The type of the monitored object. Can be one of the following: `schema` or `table` */ objectType: string; pageSize?: number; } /** * A collection of values returned by getDataQualityRefreshes. */ export interface GetDataQualityRefreshesResult { /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * (string) - The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`. */ readonly objectId: string; /** * (string) - The type of the monitored object. Can be one of the following: `schema`or `table` */ readonly objectType: string; readonly pageSize?: number; readonly refreshes: outputs.GetDataQualityRefreshesRefresh[]; } /** * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types) * * This data source can be used to fetch the list of data quality refreshes on a Unity Catalog table. * * The caller must either: * 1. be an owner of the table's parent catalog * 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema. * 3. have the following permissions: * - **USE_CATALOG** on the table's parent catalog * - **USE_SCHEMA** on the table's parent schema * - **SELECT** privilege on the table. * * > **Note** This data source can only be used with a workspace-level provider! * * ## Example Usage * * Getting a list of all data quality refresh for a given table: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as databricks from "@pulumi/databricks"; * * const _this = databricks.getTable({ * name: "my_catalog.my_schema.my_table", * }); * const all = _this.then(_this => databricks.getDataQualityRefreshes({ * objectType: "table", * objectId: _this.id, * })); * ``` */ export declare function getDataQualityRefreshesOutput(args: GetDataQualityRefreshesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDataQualityRefreshesResult>; /** * A collection of arguments for invoking getDataQualityRefreshes. */ export interface GetDataQualityRefreshesOutputArgs { /** * The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`. * * Find the `schemaId` from either: * 1. The [schemaId](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field. * * Find the `tableId` from either: * 1. The [tableId](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field */ objectId: pulumi.Input<string>; /** * The type of the monitored object. Can be one of the following: `schema` or `table` */ objectType: pulumi.Input<string>; pageSize?: pulumi.Input<number>; }