Class: Google::Iam::V1::GetPolicyOptions

Inherits:

Object

• Object
• Google::Iam::V1::GetPolicyOptions

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/iam/v1/options.rb

Overview

Encapsulates settings provided to GetIamPolicy.

Instance Attribute Summary

• #requested_policy_version ⇒ ::Integer

  Optional.

Instance Attribute Details

#requested_policy_version ⇒ ::Integer

Returns 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.

# File 'proto_docs/google/iam/v1/options.rb', line 44

class GetPolicyOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end