Google Cloud Org Policy V2 Client - Class DeletePolicyRequest (0.6.3)

Reference documentation and code samples for the Google Cloud Org Policy V2 Client class DeletePolicyRequest.

The request sent to the DeletePolicy method.

Generated from protobuf message google.cloud.orgpolicy.v2.DeletePolicyRequest

Namespace

Google \ Cloud \ OrgPolicy \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the policy to delete. See the policy entry for naming rules.

↳ etag string

Optional. The current etag of policy. If an etag is provided and does not match the current etag of the policy, deletion will be blocked and an ABORTED error will be returned.

getName

Required. Name of the policy to delete.

See the policy entry for naming rules.

Returns
Type Description
string

setName

Required. Name of the policy to delete.

See the policy entry for naming rules.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The current etag of policy. If an etag is provided and does not match the current etag of the policy, deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

Optional. The current etag of policy. If an etag is provided and does not match the current etag of the policy, deletion will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the policy to delete. See the policy entry for naming rules. Please see Google\Cloud\OrgPolicy\V2\OrgPolicyClient::policyName() for help formatting this field.

Returns
Type Description
Google\Cloud\OrgPolicy\V2\DeletePolicyRequest