Google Cloud Iam V3 Client - Class DeletePrincipalAccessBoundaryPolicyRequest (1.2.1)

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

Request message for DeletePrincipalAccessBoundaryPolicy method.

Generated from protobuf message google.iam.v3.DeletePrincipalAccessBoundaryPolicyRequest

Namespace

Google \ Cloud \ Iam \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The name of the principal access boundary policy to delete. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`
`↳ etag`	`string` Optional. The etag of the principal access boundary policy. If this is provided, it must match the server's etag.
`↳ validate_only`	`bool` Optional. If set, validate the request and preview the deletion, but do not actually post it.
`↳ force`	`bool` Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.

getName

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Returns
Type	Description
`string`

setName

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEtag

Optional. The etag of the principal access boundary policy.

If this is provided, it must match the server's etag.

Returns
Type	Description
`string`

setEtag

Optional. The etag of the principal access boundary policy.

If this is provided, it must match the server's etag.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValidateOnly

Optional. If set, validate the request and preview the deletion, but do not actually post it.

Returns
Type	Description
`bool`

setValidateOnly

Optional. If set, validate the request and preview the deletion, but do not actually post it.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getForce

Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.

Returns
Type	Description
`bool`

setForce

Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

name

string

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id} Please see PrincipalAccessBoundaryPoliciesClient::principalAccessBoundaryPolicyName() for help formatting this field.

Returns
Type	Description
`DeletePrincipalAccessBoundaryPolicyRequest`