Reference documentation and code samples for the Google Cloud Iam V3 Client class DeleteAccessPolicyRequest.
Request message for DeleteAccessPolicy method.
Generated from protobuf message google.iam.v3.DeleteAccessPolicyRequest
Namespace
Google \ Cloud \ Iam \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the access policy to delete. Format: |
↳ etag |
string
Optional. The etag of the access policy. If this is provided, it must match the server's etag. |
↳ validate_only |
bool
Optional. If set, validate the request and preview the deletion, but do not actually post it. |
↳ force |
bool
Optional. If set to true, the request will force the deletion of the Policy even if the Policy references PolicyBindings. |
getName
Required. The name of the access policy to delete.
Format:
projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}
projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}
folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}
organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the access policy to delete.
Format:
projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}
projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}
folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}
organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The etag of the access policy. If this is provided, it must match the server's etag.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The etag of the access policy. If this is provided, it must match the server's etag.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidateOnly
Optional. If set, validate the request and preview the deletion, but do not actually post it.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
Optional. If set, validate the request and preview the deletion, but do not actually post it.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
Optional. If set to true, the request will force the deletion of the Policy even if the Policy references PolicyBindings.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
Optional. If set to true, the request will force the deletion of the Policy even if the Policy references PolicyBindings.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The name of the access policy to delete. Format:
|
| Returns | |
|---|---|
| Type | Description |
DeleteAccessPolicyRequest |
|