Data Loss Prevention V2 Client - Class ListProjectDataProfilesRequest (2.9.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class ListProjectDataProfilesRequest.

Request to list the profiles generated for a given organization or project.

Generated from protobuf message google.privacy.dlp.v2.ListProjectDataProfilesRequest

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. organizations/{org_id}/locations/{loc_id}
↳ page_token string

Page token to continue retrieval.
↳ page_size int

Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
↳ order_by 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. Only one order field at a time is allowed. Examples: * * project_id * * sensitivity_level desc Supported fields: - project_id: Google Cloud project ID - sensitivity_level: How sensitive the data in a project is, at most - data_risk_level: How much risk is associated with this data - profile_last_generated: Date and time (in epoch seconds) the profile was last generated
↳ filter 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: - project_id: the Google Cloud project ID - sensitivity_level: HIGH|MODERATE|LOW - data_risk_level: HIGH|MODERATE|LOW - status_code: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - profile_last_generated: Date and time the profile was last generated * * The operator must be = or !=. The profile_last_generated filter also supports < and >. The syntax is based on https://google.aip.dev/160. Examples: * * project_id = 12345 AND status_code = 1 * * project_id = 12345 AND sensitivity_level = HIGH * * profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters.

getParent

Required. organizations/{org_id}/locations/{loc_id}

Returns
Type Description
string

setParent

Required. organizations/{org_id}/locations/{loc_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

Page token to continue retrieval.

Returns
Type Description
string

setPageToken

Page token to continue retrieval.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.

Returns
Type Description
int

setPageSize

Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getOrderBy

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. Only one order field at a time is allowed.

Examples:

  • project_id
  • sensitivity_level desc Supported fields:
  • project_id: Google Cloud project ID
  • sensitivity_level: How sensitive the data in a project is, at most
  • data_risk_level: How much risk is associated with this data
  • profile_last_generated: Date and time (in epoch seconds) the profile was last generated
Returns
Type Description
string

setOrderBy

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. Only one order field at a time is allowed.

Examples:

  • project_id
  • sensitivity_level desc Supported fields:
  • project_id: Google Cloud project ID
  • sensitivity_level: How sensitive the data in a project is, at most
  • data_risk_level: How much risk is associated with this data
  • profile_last_generated: Date and time (in epoch seconds) the profile was last generated
Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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:
  • The operator must be = or !=. The profile_last_generated filter also supports < and >. The syntax is based on https://google.aip.dev/160. Examples:
  • project_id = 12345 AND status_code = 1
  • project_id = 12345 AND sensitivity_level = HIGH
  • profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters.
Returns
Type Description
string

setFilter

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:
  • The operator must be = or !=. The profile_last_generated filter also supports < and >. The syntax is based on https://google.aip.dev/160. Examples:
  • project_id = 12345 AND status_code = 1
  • project_id = 12345 AND sensitivity_level = HIGH
  • profile_last_generated < "2025-01-01T00:00:00.000Z" The length of this field should be no more than 500 characters.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. organizations/{org_id}/locations/{loc_id} Please see DlpServiceClient::organizationLocationName() for help formatting this field.
Returns
Type Description
ListProjectDataProfilesRequest