Class: OCI::Identity::Models::Group

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

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 = {}) ⇒ Group

Initializes the object



66
67
68
69
70
71
72
73
74
75
76
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
 
# File 'lib/oci/identity/models/group.rb', line 66

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

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

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

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

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy containing the group.



21
22
23
 
# File 'lib/oci/identity/models/group.rb', line 21

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`



61
62
63
 
# File 'lib/oci/identity/models/group.rb', line 61

def defined_tags
  @defined_tags
end

#description ⇒ String

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



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

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists solely for compatibility with other cloud provider tagging schemes. Example: ‘"value"`



55
56
57
 
# File 'lib/oci/identity/models/group.rb', line 55

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the group.



17
18
19
 
# File 'lib/oci/identity/models/group.rb', line 17

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.



48
49
50
 
# File 'lib/oci/identity/models/group.rb', line 48

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

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



44
45
46
 
# File 'lib/oci/identity/models/group.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

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



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

def name
  @name
end

#time_created ⇒ DateTime

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

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



38
39
40
 
# File 'lib/oci/identity/models/group.rb', line 38

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/identity/models/group.rb', line 122

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 &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/identity/models/group.rb', line 151

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

See Also:

  • `==` method


138
139
140
 
# File 'lib/oci/identity/models/group.rb', line 138

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



144
145
146
 
# File 'lib/oci/identity/models/group.rb', line 144

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

#to_hash ⇒ Hash

Returns the object in the form of hash



176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/identity/models/group.rb', line 176

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



170
171
172
 
# File 'lib/oci/identity/models/group.rb', line 170

def to_s
  to_hash.to_s
end