Data Loss Prevention V2 Client - Class ListFileStoreDataProfilesRequest (1.17.0)

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

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

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.
`↳ page_token`	`string` Optional. Page token to continue retrieval.
`↳ page_size`	`int` Optional. 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` Optional. 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 asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.
`↳ filter`	`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: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH\|MODERATE\|LOW - `data_risk_level` - HIGH\|MODERATE\|LOW - `resource_visibility`: PUBLIC\|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters.

getParent

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

Returns
Type	Description
`string`

setParent

Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageToken

Optional. Page token to continue retrieval.

Returns
Type	Description
`string`

setPageToken

Optional. Page token to continue retrieval.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

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

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

Optional. 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 asc
name
sensitivity_level desc Supported fields are:
project_id: The Google Cloud project ID.
sensitivity_level: How sensitive the data in a table is, at most.
data_risk_level: How much risk is associated with this data.
profile_last_generated: When the profile was last updated in epoch seconds.
last_modified: The last time the resource was modified.
resource_visibility: Visibility restriction for this resource.
name: The name of the profile.
create_time: The time the file store was first created.

Returns
Type	Description
`string`

setOrderBy

Examples:

project_id asc
name
sensitivity_level desc Supported fields are:
project_id: The Google Cloud project ID.
sensitivity_level: How sensitive the data in a table is, at most.
data_risk_level: How much risk is associated with this data.
profile_last_generated: When the profile was last updated in epoch seconds.
last_modified: The last time the resource was modified.
resource_visibility: Visibility restriction for this resource.
name: The name of the profile.
create_time: The time the file store was first created.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

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:
- project_id - The Google Cloud project ID.
- file_store_path - The path like "gs://bucket".
- sensitivity_level - HIGH|MODERATE|LOW
- data_risk_level - HIGH|MODERATE|LOW
- resource_visibility: PUBLIC|RESTRICTED
- status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
The operator must be = or !=. Examples:
project_id = 12345 AND status_code = 1
project_id = 12345 AND sensitivity_level = HIGH
project_id = 12345 AND resource_visibility = PUBLIC
file_store_path = "gs://mybucket" The length of this field should be no more than 500 characters.

Returns
Type	Description
`string`

setFilter

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:
- project_id - The Google Cloud project ID.
- file_store_path - The path like "gs://bucket".
- sensitivity_level - HIGH|MODERATE|LOW
- data_risk_level - HIGH|MODERATE|LOW
- resource_visibility: PUBLIC|RESTRICTED
- status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
The operator must be = or !=. Examples:
project_id = 12345 AND status_code = 1
project_id = 12345 AND sensitivity_level = HIGH
project_id = 12345 AND resource_visibility = PUBLIC
file_store_path = "gs://mybucket" 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. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. Please see Google\Cloud\Dlp\V2\DlpServiceClient::organizationLocationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dlp\V2\ListFileStoreDataProfilesRequest`