Reference documentation and code samples for the Google API Common Protos V1 Client class GetPolicyOptions.
Encapsulates settings provided to GetIamPolicy.
Generated from protobuf message google.iam.v1.GetPolicyOptions
Namespace
Google \ Cloud \ Iam \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ requested_policy_version
int
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
getRequestedPolicyVersion
Optional. The maximum policy version that will be used to format the
policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Requests for policies with any conditional role bindings must specify
version 3. Policies with no conditional role bindings may specify any valid
value or leave the field unset.
The policy in the response might use the policy version that you specified,
or it might use a lower policy version. For example, if you specify version
3, but the policy has no conditional role bindings, the response uses
version 1.
To learn which resources support conditions in their IAM policies, see the
IAM
documentation.
Returns
Type
Description
int
setRequestedPolicyVersion
Optional. The maximum policy version that will be used to format the
policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Requests for policies with any conditional role bindings must specify
version 3. Policies with no conditional role bindings may specify any valid
value or leave the field unset.
The policy in the response might use the policy version that you specified,
or it might use a lower policy version. For example, if you specify version
3, but the policy has no conditional role bindings, the response uses
version 1.
To learn which resources support conditions in their IAM policies, see the
IAM
documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google API Common Protos V1 Client - Class GetPolicyOptions (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Cloud.Iam.V1.GetPolicyOptions)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Cloud.Iam.V1.GetPolicyOptions)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Cloud.Iam.V1.GetPolicyOptions)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Cloud.Iam.V1.GetPolicyOptions)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Cloud.Iam.V1.GetPolicyOptions)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Cloud.Iam.V1.GetPolicyOptions) \nReference documentation and code samples for the Google API Common Protos V1 Client class GetPolicyOptions.\n\nEncapsulates settings provided to GetIamPolicy.\n\nGenerated from protobuf message `google.iam.v1.GetPolicyOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Iam \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRequestedPolicyVersion\n\nOptional. The maximum policy version that will be used to format the\npolicy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\nRequests for policies with any conditional role bindings must specify\nversion 3. Policies with no conditional role bindings may specify any valid\nvalue or leave the field unset.\nThe policy in the response might use the policy version that you specified,\nor it might use a lower policy version. For example, if you specify version\n3, but the policy has no conditional role bindings, the response uses\nversion 1.\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n### setRequestedPolicyVersion\n\nOptional. The maximum policy version that will be used to format the\npolicy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\nRequests for policies with any conditional role bindings must specify\nversion 3. Policies with no conditional role bindings may specify any valid\nvalue or leave the field unset.\nThe policy in the response might use the policy version that you specified,\nor it might use a lower policy version. For example, if you specify version\n3, but the policy has no conditional role bindings, the response uses\nversion 1.\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)."]]
