Reference documentation and code samples for the Google Cloud Iam V3 Client class CreateAccessPolicyRequest.
Request message for CreateAccessPolicy method.
Generated from protobuf message google.iam.v3.CreateAccessPolicyRequest
Namespace
Google \ Cloud \ Iam \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource where this access policy will be created. Format: |
↳ access_policy_id |
string
Required. The ID to use for the access policy, which will become the final component of the access 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}/. This value must be unique among all access policies with the same parent. |
↳ access_policy |
AccessPolicy
Required. The access 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 access policy will be created.
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 access policy will be created.
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 |
|
getAccessPolicyId
Required. The ID to use for the access policy, which will become the final component of the access 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}/. This value must be unique among all access policies with the same parent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccessPolicyId
Required. The ID to use for the access policy, which will become the final component of the access 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}/. This value must be unique among all access policies with the same parent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessPolicy
Required. The access policy to create.
| Returns | |
|---|---|
| Type | Description |
AccessPolicy|null |
|
hasAccessPolicy
clearAccessPolicy
setAccessPolicy
Required. The access policy to create.
| Parameter | |
|---|---|
| Name | Description |
var |
AccessPolicy
|
| 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 access policy will be created. Format:
|
accessPolicy |
AccessPolicy
Required. The access policy to create. |
accessPolicyId |
string
Required. The ID to use for the access policy, which will become the final component of the access 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}/. This value must be unique among all access policies with the same parent. |
| Returns | |
|---|---|
| Type | Description |
CreateAccessPolicyRequest |
|