generateDataQualityRules method

Future<GoogleCloudDataplexV1GenerateDataQualityRulesResponse> generateDataQualityRules(
  1. GoogleCloudDataplexV1GenerateDataQualityRulesRequest request,
  2. String name, {
  3. String? $fields,
})

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

request - The metadata request object.

Request parameters:

name - Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/dataScans/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudDataplexV1GenerateDataQualityRulesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudDataplexV1GenerateDataQualityRulesResponse>
    generateDataQualityRules(
  GoogleCloudDataplexV1GenerateDataQualityRulesRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$name') + ':generateDataQualityRules';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudDataplexV1GenerateDataQualityRulesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}