@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
93 lines • 3.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves the generated data quality rules for the creating a new data quality scan.
* For more information see
* the [official documentation](https://cloud.google.com/dataplex/docs)
* and [API](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataScans/generateDataQualityRules).
*
* ## example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dqrs = gcp.dataplex.getDataQualityRules({
* project: "my-project",
* location: "use-central1",
* dataScanId: "my-datascan-profile",
* });
* ```
*/
export declare function getDataQualityRules(args: GetDataQualityRulesArgs, opts?: pulumi.InvokeOptions): Promise<GetDataQualityRulesResult>;
/**
* A collection of arguments for invoking getDataQualityRules.
*/
export interface GetDataQualityRulesArgs {
/**
* The ID of the data profile scan which the generation of quality rules will be basing on.
*/
dataScanId: string;
/**
* The location where the referenced data profile scan resides.
*/
location?: string;
/**
* The ID of the project in which the datascan belongs.
*/
project?: string;
}
/**
* A collection of values returned by getDataQualityRules.
*/
export interface GetDataQualityRulesResult {
readonly dataScanId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly location?: string;
readonly project?: string;
/**
* (Computed) The list of generated data quality rules. For more details, please see the datascan page.
*/
readonly rules: outputs.dataplex.GetDataQualityRulesRule[];
}
/**
* Retrieves the generated data quality rules for the creating a new data quality scan.
* For more information see
* the [official documentation](https://cloud.google.com/dataplex/docs)
* and [API](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataScans/generateDataQualityRules).
*
* ## example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dqrs = gcp.dataplex.getDataQualityRules({
* project: "my-project",
* location: "use-central1",
* dataScanId: "my-datascan-profile",
* });
* ```
*/
export declare function getDataQualityRulesOutput(args: GetDataQualityRulesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDataQualityRulesResult>;
/**
* A collection of arguments for invoking getDataQualityRules.
*/
export interface GetDataQualityRulesOutputArgs {
/**
* The ID of the data profile scan which the generation of quality rules will be basing on.
*/
dataScanId: pulumi.Input<string>;
/**
* The location where the referenced data profile scan resides.
*/
location?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the datascan belongs.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getDataQualityRules.d.ts.map