Class: OCI::Dns::Models::RecordOperation

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

Overview

An extension of the existing record resource, describing either a precondition, an add, or a remove. Preconditions check all fields, including read-only data like ‘recordHash` and `rrsetVersion`.

Constant Summary collapse

OPERATION_ENUM = 
[OPERATION_REQUIRE = 'REQUIRE',
OPERATION_PROHIBIT = 'PROHIBIT',
OPERATION_ADD = 'ADD',
OPERATION_REMOVE = 'REMOVE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecordOperation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :domain (String) —

    The value to assign to the #domain property

  • :record_hash (String) —

    The value to assign to the #record_hash property

  • :is_protected (BOOLEAN) —

    The value to assign to the #is_protected property

  • :rdata (String) —

    The value to assign to the #rdata property

  • :rrset_version (String) —

    The value to assign to the #rrset_version property

  • :rtype (String) —

    The value to assign to the #rtype property

  • :ttl (Integer) —

    The value to assign to the #ttl property

  • :operation (String) —

    The value to assign to the #operation property



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/dns/models/record_operation.rb', line 86

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

  if attributes[:'recordHash']
    self.record_hash = attributes[:'recordHash']
  end

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

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

  unless attributes[:'isProtected'].nil?
    self.is_protected = attributes[:'isProtected']
  end

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

  unless attributes[:'is_protected'].nil?
    self.is_protected = attributes[:'is_protected']
  end

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

  if attributes[:'rrsetVersion']
    self.rrset_version = attributes[:'rrsetVersion']
  end

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

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

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

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

  if attributes[:'operation']
    self.operation = attributes[:'operation']
  else
    self.operation = "ADD"
  end

end

Instance Attribute Details

#domain ⇒ String

The fully qualified domain name where the record can be located.

Returns:

  • (String) 


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

def domain
  @domain
end

#is_protected ⇒ BOOLEAN

A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.

Returns:

  • (BOOLEAN) 


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

def is_protected
  @is_protected
end

#operation ⇒ String

A description of how a record relates to a PATCH operation.

  • ‘REQUIRE` indicates a precondition that record data must already exist.

  • ‘PROHIBIT` indicates a precondition that record data **must not** already exist.

  • ‘ADD` indicates that record data must exist after successful application.

  • ‘REMOVE` indicates that record data **must not** exist after successful application.

    Note: ‘ADD` and `REMOVE` operations can succeed even if they require no changes when applied, such as when the described records are already present or absent.

    Note: ‘ADD` and `REMOVE` operations can describe changes for more than one record.

    Example: ‘{ "domain": "www.example.com", "rtype": "AAAA", "ttl": 60 }` specifies a new TTL for every record in the www.example.com AAAA RRSet.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/dns/models/record_operation.rb', line 73

def operation
  @operation
end

#rdata ⇒ String

The record’s data, as whitespace-delimited tokens in type-specific presentation format.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/dns/models/record_operation.rb', line 37

def rdata
  @rdata
end

#record_hash ⇒ String

A unique identifier for the record within its zone.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/dns/models/record_operation.rb', line 25

def record_hash
  @record_hash
end

#rrset_version ⇒ String

The latest version of the record’s zone in which its RRSet differs from the preceding version.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/dns/models/record_operation.rb', line 43

def rrset_version
  @rrset_version
end

#rtype ⇒ String

The canonical name for the record’s type, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).

Returns:

  • (String) 


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

def rtype
  @rtype
end

#ttl ⇒ Integer

The Time To Live for the record, in seconds.

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/dns/models/record_operation.rb', line 53

def ttl
  @ttl
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/dns/models/record_operation.rb', line 158

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      domain == other_object.domain &&
      record_hash == other_object.record_hash &&
      is_protected == other_object.is_protected &&
      rdata == other_object.rdata &&
      rrset_version == other_object.rrset_version &&
      rtype == other_object.rtype &&
      ttl == other_object.ttl &&
      operation == other_object.operation
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/dns/models/record_operation.rb', line 186

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


173
174
175
 
# File 'lib/oci/dns/models/record_operation.rb', line 173

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/oci/dns/models/record_operation.rb', line 179

def hash
  [domain, record_hash, is_protected, rdata, rrset_version, rtype, ttl, operation].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/dns/models/record_operation.rb', line 211

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



205
206
207
 
# File 'lib/oci/dns/models/record_operation.rb', line 205

def to_s
  to_hash.to_s
end