list method

Future<GooglePrivacyDlpV2ListJobTriggersResponse> list(String parent, { String? filter, String? locationId, String? orderBy, int? pageSize, String? pageToken, String? type, String? $fields, })

Lists job triggers.

See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers 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 triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)

• last_run_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 triggeredJob 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,update_time, create_time desc Supported fields are: - create_time: corresponds to the time the JobTrigger was created. - update_time: corresponds to the time the JobTrigger was last updated. - last_run_time: corresponds to the last time the JobTrigger ran. - name: corresponds to the JobTrigger's name. - display_name: corresponds to the JobTrigger's display name. - status: corresponds to JobTrigger's status.

pageSize - Size of the page. This value can be limited by a server.

pageToken - Page token to continue retrieval. Comes from the previous call to ListJobTriggers. order_by field must not change for subsequent calls.

type - The type of jobs. Will use DlpJobType.INSPECT if not set. 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 GooglePrivacyDlpV2ListJobTriggersResponse.

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<GooglePrivacyDlpV2ListJobTriggersResponse> 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') + '/jobTriggers';

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