Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::ListDlpJobsRequest.
The request message for listing DLP jobs.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::String) — 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 resource name of the trigger that created job.- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to time the job finished.
- Supported fields for risk analysis jobs:
state
- RUNNING|CANCELED|FINISHED|FAILED- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to 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.
#filter=
def filter=(value) -> ::String
-
value (::String) — 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 resource name of the trigger that created job.- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to time the job finished.
- Supported fields for risk analysis jobs:
state
- RUNNING|CANCELED|FINISHED|FAILED- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to 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.
-
(::String) — 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 resource name of the trigger that created job.- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to time the job finished.
- Supported fields for risk analysis jobs:
state
- RUNNING|CANCELED|FINISHED|FAILED- 'end_time` - Corresponds to time the job finished.
- 'start_time` - Corresponds to 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.
#location_id
def location_id() -> ::String
- (::String) — Deprecated. This field has no effect.
#location_id=
def location_id=(value) -> ::String
- value (::String) — Deprecated. This field has no effect.
- (::String) — Deprecated. This field has no effect.
#order_by
def order_by() -> ::String
-
(::String) —
Comma separated list of fields to order by, followed by
asc
ordesc
postfix. This list is case-insensitive, 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 time the job was created.end_time
: corresponds to time the job ended.name
: corresponds to job's name.state
: corresponds tostate
#order_by=
def order_by=(value) -> ::String
-
value (::String) —
Comma separated list of fields to order by, followed by
asc
ordesc
postfix. This list is case-insensitive, 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 time the job was created.end_time
: corresponds to time the job ended.name
: corresponds to job's name.state
: corresponds tostate
-
(::String) —
Comma separated list of fields to order by, followed by
asc
ordesc
postfix. This list is case-insensitive, 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 time the job was created.end_time
: corresponds to time the job ended.name
: corresponds to job's name.state
: corresponds tostate
#page_size
def page_size() -> ::Integer
- (::Integer) — The standard list page size.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — The standard list page size.
- (::Integer) — The standard list page size.
#page_token
def page_token() -> ::String
- (::String) — The standard list page token.
#page_token=
def page_token=(value) -> ::String
- value (::String) — The standard list page token.
- (::String) — The standard list page token.
#parent
def parent() -> ::String
-
(::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 identifierexample-project
, and specifies theeurope-west3
location for processing data:parent=projects/example-project/locations/europe-west3
- Projects scope, location specified:
#parent=
def parent=(value) -> ::String
-
value (::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 identifierexample-project
, and specifies theeurope-west3
location for processing data:parent=projects/example-project/locations/europe-west3
- Projects scope, location specified:
-
(::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 identifierexample-project
, and specifies theeurope-west3
location for processing data:parent=projects/example-project/locations/europe-west3
- Projects scope, location specified:
#type
def type() -> ::Google::Cloud::Dlp::V2::DlpJobType
-
(::Google::Cloud::Dlp::V2::DlpJobType) — The type of job. Defaults to
DlpJobType.INSPECT
#type=
def type=(value) -> ::Google::Cloud::Dlp::V2::DlpJobType
-
value (::Google::Cloud::Dlp::V2::DlpJobType) — The type of job. Defaults to
DlpJobType.INSPECT
-
(::Google::Cloud::Dlp::V2::DlpJobType) — The type of job. Defaults to
DlpJobType.INSPECT