Identity-Aware Proxy V1 API - Class Google::Iam::V1::GetPolicyOptions (v1.4.1)

Reference documentation and code samples for the Identity-Aware Proxy V1 API class Google::Iam::V1::GetPolicyOptions.

Encapsulates settings provided to GetIamPolicy.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#requested_policy_version

def requested_policy_version() -> ::Integer
Returns
  • (::Integer) — 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.

#requested_policy_version=

def requested_policy_version=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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.