Class: OCI::TenantManagerControlPlane::Models::Domain

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

Overview

The domain model that is associated with a tenancy.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_PENDING = 'PENDING'.freeze,
  STATUS_RELEASING = 'RELEASING'.freeze,
  STATUS_RELEASED = 'RELEASED'.freeze,
  STATUS_EXPIRING = 'EXPIRING'.freeze,
  STATUS_REVOKING = 'REVOKING'.freeze,
  STATUS_REVOKED = 'REVOKED'.freeze,
  STATUS_ACTIVE = 'ACTIVE'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Domain

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

  • :domain_name (String) —

    The value to assign to the #domain_name property

  • :owner_id (String) —

    The value to assign to the #owner_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :status (String) —

    The value to assign to the #status property

  • :txt_record (String) —

    The value to assign to the #txt_record 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

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 143

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.domain_name = attributes[:'domainName'] if attributes[:'domainName']

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

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

  self.owner_id = attributes[:'ownerId'] if attributes[:'ownerId']

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

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

  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.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.status = attributes[:'status'] if attributes[:'status']

  self.txt_record = attributes[:'txtRecord'] if attributes[:'txtRecord']

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

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

  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']

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

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

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

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy that has started the registration process for this domain.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 45

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


77
78
79
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 77

def defined_tags
  @defined_tags
end

#domain_name ⇒ String

[Required] The domain name.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 37

def domain_name
  @domain_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


71
72
73
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 71

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the domain.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 33

def id
  @id
end

#lifecycle_state ⇒ String

[Required] Lifecycle state of the domain.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#owner_id ⇒ String

[Required] The OCID of the tenancy that has started the registration process for this domain.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 41

def owner_id
  @owner_id
end

#status ⇒ String

[Required] Status of the domain.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 53

def status
  @status
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


83
84
85
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 83

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Date-time when this domain was created. An RFC 3339-formatted date and time string.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 61

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Date-time when this domain was last updated. An RFC 3339-formatted date and time string.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 65

def time_updated
  @time_updated
end

#txt_record ⇒ String

[Required] The code that the owner of the domain will need to add as a TXT record to their domain.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 57

def txt_record
  @txt_record
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'domain_name': :'domainName',
    'owner_id': :'ownerId',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'status': :'status',
    'txt_record': :'txtRecord',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 106

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'domain_name': :'String',
    'owner_id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'status': :'String',
    'txt_record': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 247

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

  self.class == other.class &&
    id == other.id &&
    domain_name == other.domain_name &&
    owner_id == other.owner_id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    status == other.status &&
    txt_record == other.txt_record &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 288

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


268
269
270
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 268

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 277

def hash
  [id, domain_name, owner_id, compartment_id, lifecycle_state, status, txt_record, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 321

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



315
316
317
 
# File 'lib/oci/tenant_manager_control_plane/models/domain.rb', line 315

def to_s
  to_hash.to_s
end