Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::ListDlpJobsRequest (v0.20.0)

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
Returns
  • (::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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#location_id

def location_id() -> ::String
Returns
  • (::String) — Deprecated. This field has no effect.

#location_id=

def location_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. This field has no effect.
Returns
  • (::String) — Deprecated. This field has no effect.

#order_by

def order_by() -> ::String
Returns
  • (::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

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The standard list page size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The standard list page size.
Returns
  • (::Integer) — The standard list page size.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The standard list page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The standard list page token.
Returns
  • (::String) — The standard list page token.

#parent

def parent() -> ::String
Returns
  • (::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

#parent=

def parent=(value) -> ::String
Parameter
  • 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 identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3
Returns
  • (::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

#type

def type() -> ::Google::Cloud::Dlp::V2::DlpJobType
Returns

#type=

def type=(value) -> ::Google::Cloud::Dlp::V2::DlpJobType
Parameter
Returns