Reference documentation and code samples for the Google Cloud Iam V2 Client class DeletePolicyRequest.
Request message for DeletePolicy.
Generated from protobuf message google.iam.v2.DeletePolicyRequest
Methods
build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name of the policy to delete. Format:
Use the 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. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V2\DeletePolicyRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the policy to delete. Format: |
↳ etag |
string
Optional. The expected |
getName
Required. The resource name of the policy to delete. Format:
policies/{attachment_point}/denypolicies/{policy_id}
Use the 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/my-policy.
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 | |
setName
Required. The resource name of the policy to delete. Format:
policies/{attachment_point}/denypolicies/{policy_id}
Use the 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/my-policy.
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 | |
getEtag
Optional. The expected etag of the policy to delete. If the value does not match
the value that is stored in IAM, the request fails with a 409 error code
and ABORTED status.
If you omit this field, the policy is deleted regardless of its current
etag.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Optional. The expected etag of the policy to delete. If the value does not match
the value that is stored in IAM, the request fails with a 409 error code
and ABORTED status.
If you omit this field, the policy is deleted regardless of its current
etag.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |