Class: OCI::TenantManagerControlPlane::Models::DomainSummary

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

Overview

The summary of a domain owned by a tenancy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainSummary

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



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
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
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 124

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

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

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 26

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>>) 


58
59
60
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 58

def defined_tags
  @defined_tags
end

#domain_name ⇒ String

[Required] The domain name.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 18

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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of the domain.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 14

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the domain.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 30

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) 


22
23
24
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 22

def owner_id
  @owner_id
end

#status ⇒ String

[Required] Status of the domain.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 34

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>>) 


64
65
66
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 64

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) 


42
43
44
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 42

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) 


46
47
48
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 46

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) 


38
39
40
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 38

def txt_record
  @txt_record
end

Class Method Details

.attribute_map ⇒ Object

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



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

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.



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

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 202

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 243

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


223
224
225
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 232

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



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 276

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



270
271
272
 
# File 'lib/oci/tenant_manager_control_plane/models/domain_summary.rb', line 270

def to_s
  to_hash.to_s
end