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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 use wildcard such as "policy_tag: 'projects/1/locations/us/taxonomies/2/*'".

getParent

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

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

Returns
TypeDescription
string

setParent

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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 use wildcard such as "policy_tag: 'projects/1/locations/us/taxonomies/2/*'".

Returns
TypeDescription
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 use wildcard such as "policy_tag: 'projects/1/locations/us/taxonomies/2/*'".

Parameter
NameDescription
var string
Returns
TypeDescription
$this