Class: OCI::Dns::Models::TSIG

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

Overview

A [TSIG](tools.ietf.org/html/rfc2845) key.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TSIG

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

  • :secret (String) —

    The value to assign to the #secret property

  • :algorithm (String) —

    The value to assign to the #algorithm property



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/dns/models/tsig.rb', line 55

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

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

Instance Attribute Details

#algorithm ⇒ String

[Required] TSIG Algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. For a full list of TSIG algorithms, see [Secret Key Transaction Authentication for DNS (TSIG) Algorithm Names](www.iana.org/assignments/tsig-algorithm-names/tsig-algorithm-names.xhtml#tsig-algorithm-names-1)

Returns:

  • (String) 


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

def algorithm
  @algorithm
end

#name ⇒ String

[Required] A domain name identifying the key for a given pair of hosts.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/dns/models/tsig.rb', line 11

def name
  @name
end

#secret ⇒ String

[Required] A base64 string encoding the binary shared secret.

Returns:

  • (String) 


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

def secret
  @secret
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
 
# File 'lib/oci/dns/models/tsig.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'secret': :'secret',
    'algorithm': :'algorithm'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/dns/models/tsig.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'secret': :'String',
    'algorithm': :'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



75
76
77
78
79
80
81
 
# File 'lib/oci/dns/models/tsig.rb', line 75

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    name == other.name &&
    secret == other.secret &&
    algorithm == other.algorithm
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



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/tsig.rb', line 106

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/oci/dns/models/tsig.rb', line 95

def hash
  [name, secret, algorithm].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/dns/models/tsig.rb', line 138

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



132
133
134
 
# File 'lib/oci/dns/models/tsig.rb', line 132

def to_s
  to_hash.to_s
end