Google Cloud Iam V3 Client - Class AccessPolicy (1.5.3)

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

An IAM access policy resource.

Generated from protobuf message google.iam.v3.AccessPolicy

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 access policy. The following formats are supported: * * projects/{project_id}/locations/{location}/accessPolicies/{policy_id} * * projects/{project_number}/locations/{location}/accessPolicies/{policy_id} * * folders/{folder_id}/locations/{location}/accessPolicies/{policy_id} * * organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}
↳ uid string

Output only. The globally unique ID of the access policy.
↳ etag string

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.
↳ display_name string

Optional. The description of the access 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 access policy was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time when the access policy was most recently updated.
↳ details AccessPolicyDetails

Optional. The details for the access policy.

getName

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}
Returns
Type Description
string

setName

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}
Parameter
Name Description
var string
Returns
Type Description
$this

getUid

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

Returns
Type Description
string

setUid

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

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The etag for the access policy.

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

Returns
Type Description
string

setEtag

Optional. The etag for the access policy.

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 access policy. Must be less than or equal to 63 characters.

Returns
Type Description
string

setDisplayName

Optional. The description of the access 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
Google\Protobuf\Internal\MapField

setAnnotations

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDetails

Optional. The details for the access policy.

Returns
Type Description
AccessPolicyDetails|null

hasDetails

clearDetails

setDetails

Optional. The details for the access policy.

Parameter
Name Description
var AccessPolicyDetails
Returns
Type Description
$this