Google API Common Protos V1 Client - Class SetIamPolicyRequest (4.12.4)

Reference documentation and code samples for the Google API Common Protos V1 Client class SetIamPolicyRequest.

Request message for SetIamPolicy method.

Generated from protobuf message google.iam.v1.SetIamPolicyRequest

Namespace

Google \ Cloud \ Iam \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
↳ policy Policy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
↳ update_mask Google\Protobuf\FieldMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

getResource

REQUIRED: The resource for which the policy is being specified.

See the operation documentation for the appropriate value for this field.

Returns
Type Description
string

setResource

REQUIRED: The resource for which the policy is being specified.

See the operation documentation for the appropriate value for this field.

Parameter
Name Description
var string
Returns
Type Description
$this

getPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Returns
Type Description
Policy|null

hasPolicy

clearPolicy

setPolicy

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Parameter
Name Description
var Policy
Returns
Type Description
$this

getUpdateMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this