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

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

Overview

A DNS zone.

Constant Summary collapse

ZONE_TYPE_ENUM = 
[ZONE_TYPE_PRIMARY = 'PRIMARY',
ZONE_TYPE_SECONDARY = 'SECONDARY',
ZONE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute 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

  • :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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/oci/dns/models/zone_summary.rb', line 65

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the zone.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/dns/models/zone_summary.rb', line 24

def compartment_id
  @compartment_id
end

#id ⇒ String

The OCID of the zone.

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String

The name of the zone.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/dns/models/zone_summary.rb', line 15

def name
  @name
end

#self_uri ⇒ String

The canonical absolute URL of the resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/dns/models/zone_summary.rb', line 28

def self_uri
  @self_uri
end

#serial ⇒ Integer

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

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/dns/models/zone_summary.rb', line 52

def serial
  @serial
end

#time_created ⇒ DateTime

The date and time the image 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) 


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

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) 


47
48
49
 
# File 'lib/oci/dns/models/zone_summary.rb', line 47

def version
  @version
end

#zone_type ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/dns/models/zone_summary.rb', line 20

def zone_type
  @zone_type
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/dns/models/zone_summary.rb', line 141

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      name == other_object.name &&
      zone_type == other_object.zone_type &&
      compartment_id == other_object.compartment_id &&
      self_uri == other_object.self_uri &&
      id == other_object.id &&
      time_created == other_object.time_created &&
      version == other_object.version &&
      serial == other_object.serial
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/dns/models/zone_summary.rb', line 169

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.public_method("#{key}=").call(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.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


156
157
158
 
# File 'lib/oci/dns/models/zone_summary.rb', line 156

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/dns/models/zone_summary.rb', line 162

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/dns/models/zone_summary.rb', line 194

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



188
189
190
 
# File 'lib/oci/dns/models/zone_summary.rb', line 188

def to_s
  to_hash.to_s
end