Google Cloud Iam V3 Client - Class ListAccessPoliciesRequest (1.5.3)

Reference documentation and code samples for the Google Cloud Iam V3 Client class ListAccessPoliciesRequest.

Request message for ListAccessPolicies method.

Generated from protobuf message google.iam.v3.ListAccessPoliciesRequest

Namespace

Google \ Cloud \ Iam \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource, which owns the collection of access policy resources. Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

↳ page_size int

Optional. The maximum number of access policies to return. The service may return fewer than this value. If unspecified, at most 50 access policies will be returned. Valid value ranges from 1 to 1000; values above 1000 will be coerced to 1000.

↳ page_token string

Optional. A page token, received from a previous ListAccessPolicies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccessPolicies must match the call that provided the page token.

getParent

Required. The parent resource, which owns the collection of access policy resources.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

Returns
Type Description
string

setParent

Required. The parent resource, which owns the collection of access policy resources.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of access policies to return. The service may return fewer than this value.

If unspecified, at most 50 access policies will be returned. Valid value ranges from 1 to 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of access policies to return. The service may return fewer than this value.

If unspecified, at most 50 access policies will be returned. Valid value ranges from 1 to 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListAccessPolicies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccessPolicies must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListAccessPolicies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccessPolicies must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource, which owns the collection of access policy resources.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location} Please see AccessPoliciesClient::organizationLocationName() for help formatting this field.

Returns
Type Description
ListAccessPoliciesRequest