Class: OCI::Identity::Models::DynamicGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/dynamic_group.rb

Overview

A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups.

This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see [Managing Dynamic Groups](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicGroup

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :matching_rule (String) —

    The value to assign to the #matching_rule property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer) —

    The value to assign to the #inactive_status property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 77

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  if attributes[:'compartment_id']
    self.compartment_id = attributes[:'compartment_id']
  end

  if attributes[:'name']
    self.name = attributes[:'name']
  end

  if attributes[:'description']
    self.description = attributes[:'description']
  end

  if attributes[:'matchingRule']
    self.matching_rule = attributes[:'matchingRule']
  end

  raise 'You cannot provide both :matchingRule and :matching_rule' if attributes.key?(:'matchingRule') && attributes.key?(:'matching_rule')

  if attributes[:'matching_rule']
    self.matching_rule = attributes[:'matching_rule']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  if attributes[:'time_created']
    self.time_created = attributes[:'time_created']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  if attributes[:'lifecycle_state']
    self.lifecycle_state = attributes[:'lifecycle_state']
  end

  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end

  raise 'You cannot provide both :inactiveStatus and :inactive_status' if attributes.key?(:'inactiveStatus') && attributes.key?(:'inactive_status')

  if attributes[:'inactive_status']
    self.inactive_status = attributes[:'inactive_status']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the tenancy containing the group.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 31

def compartment_id
  @compartment_id
end

#description ⇒ String

[Required] The description you assign to the group. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 41

def description
  @description
end

#id ⇒ String

[Required] The OCID of the group.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 27

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 64

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

[Required] The group’s current state. After creating a group, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#matching_rule ⇒ String

[Required] A rule string that defines which instance certificates will be matched. For syntax, see [Managing Dynamic Groups](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm).

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 47

def matching_rule
  @matching_rule
end

#name ⇒ String

[Required] The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 37

def name
  @name
end

#time_created ⇒ DateTime

[Required] Date and time the group was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 54

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 159

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      matching_rule == other_object.matching_rule &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 187

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 174

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 180

def hash
  [id, compartment_id, name, description, matching_rule, time_created, lifecycle_state, inactive_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 212

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



206
207
208
 
# File 'lib/oci/identity/models/dynamic_group.rb', line 206

def to_s
  to_hash.to_s
end