Google Cloud BigQuery Data Policies V1 Client - Class ListDataPoliciesRequest (0.5.5)

Reference documentation and code samples for the Google Cloud BigQuery Data Policies V1 Client class ListDataPoliciesRequest.

Request message for the ListDataPolicies method.

Generated from protobuf message google.cloud.bigquery.datapolicies.v1.ListDataPoliciesRequest

Namespace

Google \ Cloud \ BigQuery \ DataPolicies \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}.

↳ page_size int

The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.

↳ page_token string

The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.

↳ filter string

Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.

getParent

Required. Resource name of the project for which to list data policies.

Format is projects/{project_number}/locations/{location_id}.

Returns
Type Description
string

setParent

Required. Resource name of the project for which to list data policies.

Format is projects/{project_number}/locations/{location_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of data policies to return. Must be a value between 1 and 1000.

If not set, defaults to 50.

Returns
Type Description
int

setPageSize

The maximum number of data policies to return. Must be a value between 1 and 1000.

If not set, defaults to 50.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.

Returns
Type Description
string

setPageToken

The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3".

You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.

Returns
Type Description
string

setFilter

Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3".

You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}. Please see Google\Cloud\BigQuery\DataPolicies\V1\DataPolicyServiceClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\BigQuery\DataPolicies\V1\ListDataPoliciesRequest