Class: Google::Cloud::Dlp::V2::ListDlpJobsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/privacy/dlp/v2/dlp.rb

Overview

The request message for listing DLP jobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#location_id ⇒ ::String

Returns Deprecated. This field has no effect.

Returns:

  • (::String) —

    Deprecated. This field has no effect.



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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


4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns The standard list page size.

Returns:

  • (::Integer) —

    The standard list page size.



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns The standard list page token.

Returns:

  • (::String) —

    The standard list page token.



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

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

Returns:



4592
4593
4594
4595
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4592

class ListDlpJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end