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 =

rubocop:disable Metrics/LineLength

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

Instance Attribute Summary collapse

Class Method 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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

  self.operation = attributes[:'operation'] if attributes[:'operation']
  self.operation = "ADD" if operation.nil? && !attributes.key?(:'operation') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#domain ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/dns/models/record_operation.rb', line 22

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) 


33
34
35
 
# File 'lib/oci/dns/models/record_operation.rb', line 33

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) 


75
76
77
 
# File 'lib/oci/dns/models/record_operation.rb', line 75

def operation
  @operation
end

#rdata ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/dns/models/record_operation.rb', line 39

def rdata
  @rdata
end

#record_hash ⇒ String

A unique identifier for the record within its zone.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/dns/models/record_operation.rb', line 27

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) 


45
46
47
 
# File 'lib/oci/dns/models/record_operation.rb', line 45

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) 


51
52
53
 
# File 'lib/oci/dns/models/record_operation.rb', line 51

def rtype
  @rtype
end

#ttl ⇒ Integer

The Time To Live for the record, in seconds.

Returns:

  • (Integer) 


55
56
57
 
# File 'lib/oci/dns/models/record_operation.rb', line 55

def ttl
  @ttl
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/dns/models/record_operation.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'domain': :'domain',
    'record_hash': :'recordHash',
    'is_protected': :'isProtected',
    'rdata': :'rdata',
    'rrset_version': :'rrsetVersion',
    'rtype': :'rtype',
    'ttl': :'ttl',
    'operation': :'operation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'domain': :'String',
    'record_hash': :'String',
    'is_protected': :'BOOLEAN',
    'rdata': :'String',
    'rrset_version': :'String',
    'rtype': :'String',
    'ttl': :'Integer',
    'operation': :'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



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/dns/models/record_operation.rb', line 175

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/dns/models/record_operation.rb', line 211

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


191
192
193
 
# File 'lib/oci/dns/models/record_operation.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/dns/models/record_operation.rb', line 200

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/dns/models/record_operation.rb', line 243

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



237
238
239
 
# File 'lib/oci/dns/models/record_operation.rb', line 237

def to_s
  to_hash.to_s
end