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 \ V2Methods
__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: |
↳ filter |
string
Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by |
↳ page_size |
int
The standard list page size. |
↳ page_token |
string
The standard list page token. |
↳ type |
int
The type of job. Defaults to |
↳ order_by |
string
Comma separated list of fields to order by, followed by |
↳ location_id |
string
Deprecated. This field has no effect. |
getParent
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-west3
location for processing data: parent=projects/example-project/locations/europe-west3
Returns | |
---|---|
Type | Description |
string |
setParent
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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-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
orOR
logical operators. A sequence of restrictions implicitly usesAND
. - A restriction has the form of
{field} {operator} {value}
. - Supported fields/values for inspect jobs:
state
- PENDING|RUNNING|CANCELED|FINISHED|FAILEDinspected_storage
- DATASTORE|CLOUD_STORAGE|BIGQUERYtrigger_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.
Returns | |
---|---|
Type | Description |
string |
setFilter
Allows filtering.
Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by
AND
orOR
logical operators. A sequence of restrictions implicitly usesAND
. - A restriction has the form of
{field} {operator} {value}
. - Supported fields/values for inspect jobs:
state
- PENDING|RUNNING|CANCELED|FINISHED|FAILEDinspected_storage
- DATASTORE|CLOUD_STORAGE|BIGQUERYtrigger_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 tostate
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.end_time
: corresponds to the time the job ended.name
: corresponds to the job's name.state
: corresponds tostate
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLocationId
Deprecated. This field has no effect.
Returns | |
---|---|
Type | Description |
string |
setLocationId
Deprecated. This field has no effect.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location:
The following example parent=projects/example-project/locations/europe-west3 Please see Google\Cloud\Dlp\V2\DlpServiceClient::projectName() for help formatting this field. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dlp\V2\ListDlpJobsRequest |