Reference documentation and code samples for the Data Loss Prevention V2 Client class ListDlpJobsRequest.
The request message for listing DLP jobs.
Generated from protobuf message google.privacy.dlp.v2.ListDlpJobsRequest
Namespace
Google \ Cloud \ Dlp \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
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
↳ filter
string
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.
↳ page_size
int
The standard list page size.
↳ page_token
string
The standard list page token.
↳ type
int
The type of job. Defaults to DlpJobType.INSPECT
↳ order_by
string
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
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
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
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
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}.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The standard list page size.
Returns
Type
Description
int
setPageSize
The standard list page size.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
The standard list page token.
Returns
Type
Description
string
setPageToken
The standard list page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getType
The type of job. Defaults to DlpJobType.INSPECT
Returns
Type
Description
int
setType
The type of job. Defaults to DlpJobType.INSPECT
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getOrderBy
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
Returns
Type
Description
string
setOrderBy
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.
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
Please see DlpServiceClient::projectName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Data Loss Prevention V2 Client - Class ListDlpJobsRequest (2.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.6.1 (latest)](/php/docs/reference/cloud-dlp/latest/V2.ListDlpJobsRequest)\n- [2.6.0](/php/docs/reference/cloud-dlp/2.6.0/V2.ListDlpJobsRequest)\n- [2.4.1](/php/docs/reference/cloud-dlp/2.4.1/V2.ListDlpJobsRequest)\n- [2.3.0](/php/docs/reference/cloud-dlp/2.3.0/V2.ListDlpJobsRequest)\n- [2.2.3](/php/docs/reference/cloud-dlp/2.2.3/V2.ListDlpJobsRequest)\n- [2.1.0](/php/docs/reference/cloud-dlp/2.1.0/V2.ListDlpJobsRequest)\n- [2.0.0](/php/docs/reference/cloud-dlp/2.0.0/V2.ListDlpJobsRequest)\n- [1.19.0](/php/docs/reference/cloud-dlp/1.19.0/V2.ListDlpJobsRequest)\n- [1.18.0](/php/docs/reference/cloud-dlp/1.18.0/V2.ListDlpJobsRequest)\n- [1.17.0](/php/docs/reference/cloud-dlp/1.17.0/V2.ListDlpJobsRequest)\n- [1.16.0](/php/docs/reference/cloud-dlp/1.16.0/V2.ListDlpJobsRequest)\n- [1.15.1](/php/docs/reference/cloud-dlp/1.15.1/V2.ListDlpJobsRequest)\n- [1.14.0](/php/docs/reference/cloud-dlp/1.14.0/V2.ListDlpJobsRequest)\n- [1.13.2](/php/docs/reference/cloud-dlp/1.13.2/V2.ListDlpJobsRequest)\n- [1.12.0](/php/docs/reference/cloud-dlp/1.12.0/V2.ListDlpJobsRequest)\n- [1.11.0](/php/docs/reference/cloud-dlp/1.11.0/V2.ListDlpJobsRequest)\n- [1.10.2](/php/docs/reference/cloud-dlp/1.10.2/V2.ListDlpJobsRequest)\n- [1.9.0](/php/docs/reference/cloud-dlp/1.9.0/V2.ListDlpJobsRequest)\n- [1.8.6](/php/docs/reference/cloud-dlp/1.8.6/V2.ListDlpJobsRequest) \nReference documentation and code samples for the Data Loss Prevention V2 Client class ListDlpJobsRequest.\n\nThe request message for listing DLP jobs.\n\nGenerated from protobuf message `google.privacy.dlp.v2.ListDlpJobsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dlp \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Parent resource name.\n\nThe format of this value varies depending on whether you have [specified a\nprocessing\nlocation](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):\n\n- Projects scope, location specified: `projects/{project_id}/locations/{location_id}`\n- 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\n\n### setParent\n\nRequired. Parent resource name.\n\nThe format of this value varies depending on whether you have [specified a\nprocessing\nlocation](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):\n\n- Projects scope, location specified: `projects/{project_id}/locations/{location_id}`\n- 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\n\n### getFilter\n\nAllows filtering.\n\nSupported syntax:\n\n- Filter expressions are made up of one or more restrictions.\n- Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`.\n- A restriction has the form of `{field} {operator} {value}`.\n- Supported fields/values for inspect jobs:\n - `state` - PENDING\\|RUNNING\\|CANCELED\\|FINISHED\\|FAILED\n - `inspected_storage` - DATASTORE\\|CLOUD_STORAGE\\|BIGQUERY\n - `trigger_name` - The name of the trigger that created the job.\n - 'end_time\\` - Corresponds to the time the job finished.\n - 'start_time\\` - Corresponds to the time the job finished.\n- Supported fields for risk analysis jobs:\n - `state` - RUNNING\\|CANCELED\\|FINISHED\\|FAILED\n - 'end_time\\` - Corresponds to the time the job finished.\n - 'start_time\\` - Corresponds to the time the job finished.\n- The operator must be `=` or `!=`. Examples:\n- inspected_storage = cloud_storage AND state = done\n- inspected_storage = cloud_storage OR inspected_storage = bigquery\n- inspected_storage = cloud_storage AND (state = done OR state = canceled)\n- end_time \\\u003e \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.\n\n### setFilter\n\nAllows filtering.\n\nSupported syntax:\n\n- Filter expressions are made up of one or more restrictions.\n- Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`.\n- A restriction has the form of `{field} {operator} {value}`.\n- Supported fields/values for inspect jobs:\n - `state` - PENDING\\|RUNNING\\|CANCELED\\|FINISHED\\|FAILED\n - `inspected_storage` - DATASTORE\\|CLOUD_STORAGE\\|BIGQUERY\n - `trigger_name` - The name of the trigger that created the job.\n - 'end_time\\` - Corresponds to the time the job finished.\n - 'start_time\\` - Corresponds to the time the job finished.\n- Supported fields for risk analysis jobs:\n - `state` - RUNNING\\|CANCELED\\|FINISHED\\|FAILED\n - 'end_time\\` - Corresponds to the time the job finished.\n - 'start_time\\` - Corresponds to the time the job finished.\n- The operator must be `=` or `!=`. Examples:\n- inspected_storage = cloud_storage AND state = done\n- inspected_storage = cloud_storage OR inspected_storage = bigquery\n- inspected_storage = cloud_storage AND (state = done OR state = canceled)\n- end_time \\\u003e \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.\n\n### getPageSize\n\nThe standard list page size.\n\n### setPageSize\n\nThe standard list page size.\n\n### getPageToken\n\nThe standard list page token.\n\n### setPageToken\n\nThe standard list page token.\n\n### getType\n\nThe type of job. Defaults to `DlpJobType.INSPECT`\n\n### setType\n\nThe type of job. Defaults to `DlpJobType.INSPECT`\n\n### getOrderBy\n\nComma-separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case insensitive. The\ndefault sorting order is ascending. Redundant space characters are\ninsignificant.\n\nExample: `name asc, end_time asc, create_time desc`\nSupported fields are:\n\n- `create_time`: corresponds to the time the job was created.\n- `end_time`: corresponds to the time the job ended.\n- `name`: corresponds to the job's name.\n- `state`: corresponds to `state`\n\n### setOrderBy\n\nComma-separated list of fields to order by,\nfollowed by `asc` or `desc` postfix. This list is case insensitive. The\ndefault sorting order is ascending. Redundant space characters are\ninsignificant.\n\nExample: `name asc, end_time asc, create_time desc`\nSupported fields are:\n\n- `create_time`: corresponds to the time the job was created.\n- `end_time`: corresponds to the time the job ended.\n- `name`: corresponds to the job's name.\n- `state`: corresponds to `state`\n\n### getLocationId\n\nDeprecated. This field has no effect.\n\n### setLocationId\n\nDeprecated. This field has no effect.\n\n### static::build"]]
