Data Loss Prevention V2 Client - Class ListColumnDataProfilesRequest (1.18.0)

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

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

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

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

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 asc * table_id * sensitivity_level desc Supported fields are: - project_id: The Google Cloud project ID. - dataset_id: The ID of a BigQuery dataset. - table_id: The ID of a BigQuery table. - sensitivity_level: How sensitive the data in a column 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.
↳ 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/values: - table_data_profile_name - The name of the related table data profile. - project_id - The Google Cloud project ID. (REQUIRED) - dataset_id - The BigQuery dataset ID. (REQUIRED) - table_id - The BigQuery table ID. (REQUIRED) - field_id - The ID of the BigQuery field. - info_type - The infotype detected in the resource. - sensitivity_level - HIGH|MEDIUM|LOW - data_risk_level: How much risk is associated with this data. - status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be = for project_id, dataset_id, and table_id. Other filters also support !=. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS 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

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 asc
  • table_id
  • sensitivity_level desc Supported fields are:
  • project_id: The Google Cloud project ID.
  • dataset_id: The ID of a BigQuery dataset.
  • table_id: The ID of a BigQuery table.
  • sensitivity_level: How sensitive the data in a column 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.
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 asc
  • table_id
  • sensitivity_level desc Supported fields are:
  • project_id: The Google Cloud project ID.
  • dataset_id: The ID of a BigQuery dataset.
  • table_id: The ID of a BigQuery table.
  • sensitivity_level: How sensitive the data in a column 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.
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/values:
    • table_data_profile_name - The name of the related table data profile.
    • project_id - The Google Cloud project ID. (REQUIRED)
    • dataset_id - The BigQuery dataset ID. (REQUIRED)
    • table_id - The BigQuery table ID. (REQUIRED)
    • field_id - The ID of the BigQuery field.
    • info_type - The infotype detected in the resource.
    • sensitivity_level - HIGH|MEDIUM|LOW
    • data_risk_level: How much risk is associated with this data.
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = for project_id, dataset_id, and table_id. Other filters also support !=. Examples:
  • project_id = 12345 AND status_code = 1
  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND info_type = STREET_ADDRESS 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/values:
    • table_data_profile_name - The name of the related table data profile.
    • project_id - The Google Cloud project ID. (REQUIRED)
    • dataset_id - The BigQuery dataset ID. (REQUIRED)
    • table_id - The BigQuery table ID. (REQUIRED)
    • field_id - The ID of the BigQuery field.
    • info_type - The infotype detected in the resource.
    • sensitivity_level - HIGH|MEDIUM|LOW
    • data_risk_level: How much risk is associated with this data.
    • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  • The operator must be = for project_id, dataset_id, and table_id. Other filters also support !=. Examples:
  • project_id = 12345 AND status_code = 1
  • project_id = 12345 AND sensitivity_level = HIGH
  • project_id = 12345 AND info_type = STREET_ADDRESS 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\ListColumnDataProfilesRequest