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'.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



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

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

#domainString

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

Returns:

  • (String)


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

def domain
  @domain
end

#is_protectedBOOLEAN

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

Returns:

  • (BOOLEAN)


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

def is_protected
  @is_protected
end

#operationString

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)


82
83
84
# File 'lib/oci/dns/models/record_operation.rb', line 82

def operation
  @operation
end

#rdataString

The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types

Returns:

  • (String)


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

def rdata
  @rdata
end

#record_hashString

A unique identifier for the record within its zone.

Returns:

  • (String)


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

def record_hash
  @record_hash
end

#rrset_versionString

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

Returns:

  • (String)


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

def rrset_version
  @rrset_version
end

#rtypeString

The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.

Returns:

  • (String)


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

def rtype
  @rtype
end

#ttlInteger

The Time To Live for the record, in seconds.

Returns:

  • (Integer)


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

def ttl
  @ttl
end

Class Method Details

.attribute_mapObject

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/oci/dns/models/record_operation.rb', line 85

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_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/oci/dns/models/record_operation.rb', line 101

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



181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/dns/models/record_operation.rb', line 181

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/oci/dns/models/record_operation.rb', line 218

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


198
199
200
# File 'lib/oci/dns/models/record_operation.rb', line 198

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



207
208
209
# File 'lib/oci/dns/models/record_operation.rb', line 207

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
# File 'lib/oci/dns/models/record_operation.rb', line 251

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



245
246
247
# File 'lib/oci/dns/models/record_operation.rb', line 245

def to_s
  to_hash.to_s
end