Google Cloud Data Loss Prevention v2 API - Class ListDlpJobsRequest (4.8.0)

public sealed class ListDlpJobsRequest : IMessage<ListDlpJobsRequest>, IEquatable<ListDlpJobsRequest>, IDeepCloneable<ListDlpJobsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class ListDlpJobsRequest.

The request message for listing DLP jobs.

Inheritance

object > ListDlpJobsRequest

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

ListDlpJobsRequest()

public ListDlpJobsRequest()

ListDlpJobsRequest(ListDlpJobsRequest)

public ListDlpJobsRequest(ListDlpJobsRequest other)
Parameter
NameDescription
otherListDlpJobsRequest

Properties

Filter

public string Filter { get; set; }

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.

Property Value
TypeDescription
string

LocationId

public string LocationId { get; set; }

Deprecated. This field has no effect.

Property Value
TypeDescription
string

OrderBy

public string OrderBy { get; set; }

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
Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

The standard list page size.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

The standard list page token.

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>
  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var>

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
Property Value
TypeDescription
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName

ParentAsProjectName

public ProjectName ParentAsProjectName { get; set; }

ProjectName-typed view over the Parent resource name property.

Property Value
TypeDescription
ProjectName

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
TypeDescription
IResourceName

Type

public DlpJobType Type { get; set; }

The type of job. Defaults to DlpJobType.INSPECT

Property Value
TypeDescription
DlpJobType