Google Cloud Iam V3 Client - Class CreatePrincipalAccessBoundaryPolicyRequest (1.1.1)

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

Request message for CreatePrincipalAccessBoundaryPolicyRequest method.

Generated from protobuf message google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest

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 where this principal access boundary policy will be created. Only organizations are supported. Format: organizations/{organization_id}/locations/{location}

↳ principal_access_boundary_policy_id string

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

↳ principal_access_boundary_policy PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

↳ validate_only bool

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

getParent

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

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

Returns
Type Description
string

setParent

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPrincipalAccessBoundaryPolicyId

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

Returns
Type Description
string

setPrincipalAccessBoundaryPolicyId

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

Returns
Type Description
PrincipalAccessBoundaryPolicy|null

hasPrincipalAccessBoundaryPolicy

clearPrincipalAccessBoundaryPolicy

setPrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

Parameter
Name Description
var PrincipalAccessBoundaryPolicy
Returns
Type Description
$this

getValidateOnly

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

Returns
Type Description
bool

setValidateOnly

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

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

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

principalAccessBoundaryPolicy PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

principalAccessBoundaryPolicyId string

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

Returns
Type Description
CreatePrincipalAccessBoundaryPolicyRequest