Reference documentation and code samples for the Data Loss Prevention V2 Client class ListJobTriggersRequest.
Request message for ListJobTriggers.
Generated from protobuf message google.privacy.dlp.v2.ListJobTriggersRequest
Namespace
Google \ Cloud \ Dlp \ V2Methods
__construct
Constructor.
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
↳ page_token
string
Page token to continue retrieval. Comes from the previous call to ListJobTriggers. order_by
field must not change for subsequent calls.
↳ page_size
int
Size of the page. This value can be limited by a server.
↳ order_by
string
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.
↳ 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 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.
↳ type
int
The type of jobs. Will use DlpJobType.INSPECT
if not set.
↳ 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
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
var
string
$this
getPageToken
Page token to continue retrieval. Comes from the previous call
to ListJobTriggers. order_by
field must not
change for subsequent calls.
string
setPageToken
Page token to continue retrieval. Comes from the previous call
to ListJobTriggers. order_by
field must not
change for subsequent calls.
var
string
$this
getPageSize
Size of the page. This value can be limited by a server.
int
setPageSize
Size of the page. This value can be limited by a server.
var
int
$this
getOrderBy
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.
string
setOrderBy
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.
var
string
$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 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.
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 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.
var
string
$this
getType
The type of jobs. Will use DlpJobType.INSPECT
if not set.
int
setType
The type of jobs. Will use DlpJobType.INSPECT
if not set.
var
int
$this
getLocationId
Deprecated. This field has no effect.
string
setLocationId
Deprecated. This field has no effect.
var
string
$this
static::build
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 Please see DlpServiceClient::projectName() for help formatting this field.