Class: Google::Privacy::Dlp::V2::ListDlpJobsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb

Overview

The request message for listing DLP jobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns Optional. 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 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.

Returns:

  • (String) —

    Optional. 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 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.



2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end

#order_by ⇒ String

Returns Optional comma separated list of fields to order by, followed by asc or desc 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 to state.

Returns:

  • (String) —

    Optional comma separated list of fields to order by, followed by asc or desc 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 to state


2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end

#page_size ⇒ Integer

Returns The standard list page size.

Returns:

  • (Integer) —

    The standard list page size.



2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end

#page_token ⇒ String

Returns The standard list page token.

Returns:

  • (String) —

    The standard list page token.



2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end

#parent ⇒ String

Returns The parent resource name, for example projects/my-project-id.

Returns:

  • (String) —

    The parent resource name, for example projects/my-project-id.



2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end

#type ⇒ Google::Privacy::Dlp::V2::DlpJobType

Returns The type of job. Defaults to DlpJobType.INSPECT.

Returns:



2353
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 2353

class ListDlpJobsRequest; end