Class: OCI::Dns::Models::ZoneSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dns/models/zone_summary.rb

Overview

A DNS zone.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

ZONE_TYPE_ENUM = 
[
  ZONE_TYPE_PRIMARY = 'PRIMARY'.freeze,
  ZONE_TYPE_SECONDARY = 'SECONDARY'.freeze,
  ZONE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.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 = {}) ⇒ ZoneSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :zone_type (String) —

    The value to assign to the #zone_type property

  • :compartment_id (String) —

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

  • :self_uri (String) —

    The value to assign to the #self_uri property

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :version (String) —

    The value to assign to the #version property

  • :serial (Integer) —

    The value to assign to the #serial property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



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
 
# File 'lib/oci/dns/models/zone_summary.rb', line 147

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

  self.zone_type = attributes[:'zoneType'] if attributes[:'zoneType']

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the zone.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/dns/models/zone_summary.rb', line 40

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. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


58
59
60
 
# File 'lib/oci/dns/models/zone_summary.rb', line 58

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


49
50
51
 
# File 'lib/oci/dns/models/zone_summary.rb', line 49

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the zone.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/dns/models/zone_summary.rb', line 66

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the zone resource.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/dns/models/zone_summary.rb', line 90

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name of the zone.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/dns/models/zone_summary.rb', line 31

def name
  @name
end

#self_uri ⇒ String

The canonical absolute URL of the resource.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/dns/models/zone_summary.rb', line 62

def self_uri
  @self_uri
end

#serial ⇒ Integer

The current serial of the zone. As seen in the zone's SOA record.

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/oci/dns/models/zone_summary.rb', line 86

def serial
  @serial
end

#time_created ⇒ DateTime

The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/dns/models/zone_summary.rb', line 74

def time_created
  @time_created
end

#version ⇒ String

Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/dns/models/zone_summary.rb', line 81

def version
  @version
end

#zone_type ⇒ String

The type of the zone. Must be either PRIMARY or SECONDARY.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/dns/models/zone_summary.rb', line 36

def zone_type
  @zone_type
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/dns/models/zone_summary.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'zone_type': :'zoneType',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'self_uri': :'self',
    'id': :'id',
    'time_created': :'timeCreated',
    'version': :'version',
    'serial': :'serial',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/dns/models/zone_summary.rb', line 112

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'zone_type': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'self_uri': :'String',
    'id': :'String',
    'time_created': :'DateTime',
    'version': :'String',
    'serial': :'Integer',
    'lifecycle_state': :'String'
    # 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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/dns/models/zone_summary.rb', line 237

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

  self.class == other.class &&
    name == other.name &&
    zone_type == other.zone_type &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    self_uri == other.self_uri &&
    id == other.id &&
    time_created == other.time_created &&
    version == other.version &&
    serial == other.serial &&
    lifecycle_state == other.lifecycle_state
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/dns/models/zone_summary.rb', line 277

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


257
258
259
 
# File 'lib/oci/dns/models/zone_summary.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/oci/dns/models/zone_summary.rb', line 266

def hash
  [name, zone_type, compartment_id, freeform_tags, defined_tags, self_uri, id, time_created, version, serial, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/dns/models/zone_summary.rb', line 310

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



304
305
306
 
# File 'lib/oci/dns/models/zone_summary.rb', line 304

def to_s
  to_hash.to_s
end