Google Cloud Iam V3 Client - Class ListPolicyBindingsRequest (1.5.3)

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

Request message for ListPolicyBindings method.

Generated from protobuf message google.iam.v3.ListPolicyBindingsRequest

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 policy bindings. 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 policy bindings to return. The service may return fewer than this value. The default value is 50. The maximum value is 1000.
↳ page_token string

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

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following: + target + policy Some examples of filter queries: * * target:ex*: The binding target's name starts with "ex". * * target:example: The binding target's name is example. * * policy:example: The binding policy's name is example.

getParent

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

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 policy bindings.

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 policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListPolicyBindings call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPolicyBindings must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListPolicyBindings call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPolicyBindings must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following:

  • target
  • policy Some examples of filter queries:

  • target:ex*: The binding target's name starts with "ex".

  • target:example: The binding target's name is example.

  • policy:example: The binding policy's name is example.
Returns
Type Description
string

setFilter

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following:

  • target
  • policy Some examples of filter queries:

  • target:ex*: The binding target's name starts with "ex".

  • target:example: The binding target's name is example.

  • policy:example: The binding policy's name is example.
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 policy bindings.

Format:

    • projects/{project_id}/locations/{location}
    • projects/{project_number}/locations/{location}
    • folders/{folder_id}/locations/{location}
    • organizations/{organization_id}/locations/{location} Please see PolicyBindingsClient::organizationLocationName() for help formatting this field.
Returns
Type Description
ListPolicyBindingsRequest