Class: Google::Iam::V2::Policy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/iam/v2/policy.rb

Overview

Data for an IAM policy.

Defined Under Namespace

Classes: AnnotationsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the Policy was created.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the Policy was deleted. Empty if the policy is not deleted.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns A user-specified description of the Policy. This value can be up to 63 characters.

Returns:

  • (::String) —

    A user-specified description of the Policy. This value can be up to 63 characters.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns An opaque tag that identifies the current version of the Policy. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another.

If this field is present in a [CreatePolicy][] request, the value is ignored.

Returns:

  • (::String) —

    An opaque tag that identifies the current version of the Policy. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another.

    If this field is present in a [CreatePolicy][] request, the value is ignored.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kind ⇒ ::String (readonly)

Returns Output only. The kind of the Policy. Always contains the value DenyPolicy.

Returns:

  • (::String) —

    Output only. The kind of the Policy. Always contains the value DenyPolicy.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#managing_authority ⇒ ::String

Returns Immutable. Specifies that this policy is managed by an authority and can only be modified by that authority. Usage is restricted.

Returns:

  • (::String) —

    Immutable. Specifies that this policy is managed by an authority and can only be modified by that authority. Usage is restricted.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. The resource name of the Policy, which must be unique. Format: policies/{attachment_point}/denypolicies/{policy_id}

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy.

For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

Returns:

  • (::String) —

    Immutable. The resource name of the Policy, which must be unique. Format: policies/{attachment_point}/denypolicies/{policy_id}

    The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy.

    For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rules ⇒ ::Array<::Google::Iam::V2::PolicyRule>

Returns A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

Returns:

  • (::Array<::Google::Iam::V2::PolicyRule>) —

    A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String

Returns Immutable. The globally unique ID of the Policy. Assigned automatically when the Policy is created.

Returns:

  • (::String) —

    Immutable. The globally unique ID of the Policy. Assigned automatically when the Policy is created.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the Policy was last updated.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/iam/v2/policy.rb', line 78

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end