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

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/dns/models/tsig.rb', line 29

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

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

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) 


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

def algorithm
  @algorithm
end

#name ⇒ String

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

Returns:

  • (String) 


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

def name
  @name
end

#secret ⇒ String

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

Returns:

  • (String) 


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

def secret
  @secret
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



51
52
53
54
55
56
57
 
# File 'lib/oci/dns/models/tsig.rb', line 51

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/dns/models/tsig.rb', line 74

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


61
62
63
 
# File 'lib/oci/dns/models/tsig.rb', line 61

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



67
68
69
 
# File 'lib/oci/dns/models/tsig.rb', line 67

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



99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/dns/models/tsig.rb', line 99

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



93
94
95
 
# File 'lib/oci/dns/models/tsig.rb', line 93

def to_s
  to_hash.to_s
end