Google Cloud Iam V3 Client - Class PrincipalAccessBoundaryPolicy (1.1.1)

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

An IAM principal access boundary policy resource.

Generated from protobuf message google.iam.v3.PrincipalAccessBoundaryPolicy

Namespace

Google \ Cloud \ Iam \ V3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}

↳ uid
string

Output only. The globally unique ID of the principal access boundary policy.

↳ etag
string

Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.

↳ display_name
string

Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.

↳ annotations
array| Google\Protobuf\Internal\MapField

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the principal access boundary policy was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the principal access boundary policy was most recently updated.

↳ details
PrincipalAccessBoundaryPolicyDetails

Optional. The details for the principal access boundary policy.

getName

Identifier. The resource name of the principal access boundary policy.

The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}

Returns
Type
Description
string

setName

Identifier. The resource name of the principal access boundary policy.

The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. The globally unique ID of the principal access boundary policy.

Returns
Type
Description
string

setUid

Output only. The globally unique ID of the principal access boundary policy.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEtag

Optional. The etag for the principal access boundary.

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

Returns
Type
Description
string

setEtag

Optional. The etag for the principal access boundary.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.

Returns
Type
Description
string

setDisplayName

Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAnnotations

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

Returns
Type
Description

setAnnotations

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. The time when the principal access boundary policy was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the principal access boundary policy was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the principal access boundary policy was most recently updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the principal access boundary policy was most recently updated.

Parameter
Name
Description
Returns
Type
Description
$this

getDetails

Optional. The details for the principal access boundary policy.

Returns
Type
Description

hasDetails

clearDetails

setDetails

Optional. The details for the principal access boundary policy.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: