Google Cloud Iam V3 Client - Class SearchTargetPolicyBindingsRequest (1.5.3)

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

Request message for SearchTargetPolicyBindings method.

Generated from protobuf message google.iam.v3.SearchTargetPolicyBindingsRequest

Namespace

Google \ Cloud \ Iam \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ target string

Required. The target resource, which is bound to the policy in the binding. Format: * * //iam.googleapis.com/locations/global/workforcePools/POOL_ID * * //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID * * //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID * * //cloudresourcemanager.googleapis.com/projects/{project_number} * * //cloudresourcemanager.googleapis.com/folders/{folder_id} * * //cloudresourcemanager.googleapis.com/organizations/{organization_id}
↳ 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 SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.
↳ parent string

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target. Format: * * projects/{project_id}/locations/{location} * * projects/{project_number}/locations/{location} * * folders/{folder_id}/locations/{location} * * organizations/{organization_id}/locations/{location}
↳ filter string

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}". If String is empty, bindings bound to all kinds of policies would be returned. The only supported values are the following: * * "policy_kind=PRINCIPAL_ACCESS_BOUNDARY", * * "policy_kind=ACCESS"

getTarget

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
Returns
Type Description
string

setTarget

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
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 SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
string

setPageToken

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getParent

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

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 where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

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

getFilter

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned. The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"
Returns
Type Description
string

setFilter

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned. The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

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.
target string

Required. The target resource, which is bound to the policy in the binding.

Format:

    • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
    • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
    • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
    • //cloudresourcemanager.googleapis.com/projects/{project_number}
    • //cloudresourcemanager.googleapis.com/folders/{folder_id}
    • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
Returns
Type Description
SearchTargetPolicyBindingsRequest