Class: OCI::Identity::Models::Compartment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/compartment.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 = {}) ⇒ Compartment

Initializes the object



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/identity/models/compartment.rb', line 53

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

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy containing the compartment.



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

def compartment_id
  @compartment_id
end

#description ⇒ String

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



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

def description
  @description
end

#id ⇒ String

The OCID of the compartment.



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

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.



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

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

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



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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

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



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

def name
  @name
end

#time_created ⇒ DateTime

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

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



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

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/identity/models/compartment.rb', line 101

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
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/identity/models/compartment.rb', line 128

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.send("#{key}=", 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.send("#{key}=", 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


115
116
117
 
# File 'lib/oci/identity/models/compartment.rb', line 115

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



121
122
123
 
# File 'lib/oci/identity/models/compartment.rb', line 121

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

#to_hash ⇒ Hash

Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/identity/models/compartment.rb', line 153

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



147
148
149
 
# File 'lib/oci/identity/models/compartment.rb', line 147

def to_s
  to_hash.to_s
end