list method

Future<GooglePrivacyDlpV2ListDlpJobsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? locationId,
  4. String? orderBy,
  5. int? pageSize,
  6. String? pageToken,
  7. String? type,
  8. String? $fields,
})

Lists DlpJobs that match the specified filter in the request.

See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Request parameters:

parent - Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified: projects/{project_id}/locations/{location_id} + Projects scope, no location specified (defaults to global): projects/{project_id} The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3 Value must have pattern ^projects/\[^/\]+$.

filter - Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}.

  • Supported fields/values for inspect jobs: - state - PENDING|RUNNING|CANCELED|FINISHED|FAILED - inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY - trigger_name - The name of the trigger that created the job. - 'end_time - Corresponds to the time the job finished. - 'start_time - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - state - RUNNING|CANCELED|FINISHED|FAILED - 'end_time - Corresponds to the time the job finished. - 'start_time - Corresponds to the time the job finished. * The operator must be = or !=. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.

locationId - Deprecated. This field has no effect.

orderBy - Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: name asc, end_time asc, create_time desc Supported fields are: - create_time: corresponds to the time the job was created. - end_time: corresponds to the time the job ended. - name: corresponds to the job's name. - state: corresponds to state

pageSize - The standard list page size.

pageToken - The standard list page token.

type - The type of job. Defaults to DlpJobType.INSPECT Possible string values are:

  • "DLP_JOB_TYPE_UNSPECIFIED" : Defaults to INSPECT_JOB.
  • "INSPECT_JOB" : The job inspected Google Cloud for sensitive data.
  • "RISK_ANALYSIS_JOB" : The job executed a Risk Analysis computation.

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

Completes with a GooglePrivacyDlpV2ListDlpJobsResponse.

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<GooglePrivacyDlpV2ListDlpJobsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? locationId,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? type,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (locationId != null) 'locationId': [locationId],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (type != null) 'type': [type],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/dlpJobs';

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