Reference documentation and code samples for the Google Cloud Iam V2 Client class CreatePolicyRequest.
Request message for CreatePolicy.
Generated from protobuf message google.iam.v2.CreatePolicyRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The resource that the policy is attached to, along with the kind of policy
to create. Format: The attachment point is identified by its URL-encoded full resource name,
which means that the forward-slash character, For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID. |
policy |
Google\Cloud\Iam\V2\Policy
Required. The policy to create. |
policyId |
string
The ID to use for this policy, which will become the final component of
the policy's resource name. The ID must contain 3 to 63 characters. It can
contain lowercase letters and numbers, as well as dashes ( |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V2\CreatePolicyRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource that the policy is attached to, along with the kind of policy to create. Format: |
↳ policy |
Google\Cloud\Iam\V2\Policy
Required. The policy to create. |
↳ policy_id |
string
The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes ( |
getParent
Required. The resource that the policy is attached to, along with the kind of policy
to create. Format: policies/{attachment_point}/denypolicies
The attachment point is identified by its URL-encoded full resource name,
which means that the forward-slash character, /, must be written as
%2F. For example,
policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource that the policy is attached to, along with the kind of policy
to create. Format: policies/{attachment_point}/denypolicies
The attachment point is identified by its URL-encoded full resource name,
which means that the forward-slash character, /, must be written as
%2F. For example,
policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.
For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPolicy
Required. The policy to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V2\Policy|null | |
hasPolicy
clearPolicy
setPolicy
Required. The policy to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Iam\V2\Policy
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPolicyId
The ID to use for this policy, which will become the final component of
the policy's resource name. The ID must contain 3 to 63 characters. It can
contain lowercase letters and numbers, as well as dashes (-) and periods
(.). The first character must be a lowercase letter.
| Returns | |
|---|---|
| Type | Description |
string | |
setPolicyId
The ID to use for this policy, which will become the final component of
the policy's resource name. The ID must contain 3 to 63 characters. It can
contain lowercase letters and numbers, as well as dashes (-) and periods
(.). The first character must be a lowercase letter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |