Class: OCI::TenantManagerControlPlane::Models::Organization

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/tenant_manager_control_plane/models/organization.rb

Overview

An organization entity.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Organization

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :parent_name (String) —

    The value to assign to the #parent_name property

  • :default_ucm_subscription_id (String) —

    The value to assign to the #default_ucm_subscription_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



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
146
147
148
149
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 100

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 }

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

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

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

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

  self.parent_name = attributes[:'parentName'] if attributes[:'parentName']

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

  self.parent_name = attributes[:'parent_name'] if attributes[:'parent_name']

  self.default_ucm_subscription_id = attributes[:'defaultUcmSubscriptionId'] if attributes[:'defaultUcmSubscriptionId']

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

  self.default_ucm_subscription_id = attributes[:'default_ucm_subscription_id'] if attributes[:'default_ucm_subscription_id']

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

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

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of the compartment containing the organization. Always a tenancy OCID.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 32

def compartment_id
  @compartment_id
end

#default_ucm_subscription_id ⇒ String

[Required] OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 40

def default_ucm_subscription_id
  @default_ucm_subscription_id
end

#display_name ⇒ String

A display name for the organization. Avoid entering confidential information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 28

def display_name
  @display_name
end

#id ⇒ String

[Required] OCID of the organization.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 24

def id
  @id
end

#lifecycle_state ⇒ String

[Required] Lifecycle state of the organization.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#parent_name ⇒ String

The name of the tenancy that is the organization parent.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 36

def parent_name
  @parent_name
end

#time_created ⇒ DateTime

[Required] Date and time when the organization was created.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 48

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Date and time when the organization was last updated.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 52

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'parent_name': :'parentName',
    'default_ucm_subscription_id': :'defaultUcmSubscriptionId',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'parent_name': :'String',
    'default_ucm_subscription_id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 171

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    parent_name == other.parent_name &&
    default_ucm_subscription_id == other.default_ucm_subscription_id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 208

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)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 197

def hash
  [id, display_name, compartment_id, parent_name, default_ucm_subscription_id, lifecycle_state, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 241

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



235
236
237
 
# File 'lib/oci/tenant_manager_control_plane/models/organization.rb', line 235

def to_s
  to_hash.to_s
end