Class: OCI::Core::Models::TcpOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/tcp_options.rb

Overview

Optional object to specify ports for a TCP rule. If you specify TCP as the protocol but omit this object, then all ports are allowed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TcpOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/core/models/tcp_options.rb', line 27

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

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

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

  if attributes[:'sourcePortRange']
    self.source_port_range = attributes[:'sourcePortRange']
  end

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

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

end

Instance Attribute Details

#destination_port_range ⇒ OCI::Core::Models::PortRange

An inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.

Returns:



14
15
16
 
# File 'lib/oci/core/models/tcp_options.rb', line 14

def destination_port_range
  @destination_port_range
end

#source_port_range ⇒ OCI::Core::Models::PortRange

An inclusive range of allowed source ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.

Returns:



20
21
22
 
# File 'lib/oci/core/models/tcp_options.rb', line 20

def source_port_range
  @source_port_range
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



57
58
59
60
61
62
 
# File 'lib/oci/core/models/tcp_options.rb', line 57

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/core/models/tcp_options.rb', line 79

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


66
67
68
 
# File 'lib/oci/core/models/tcp_options.rb', line 66

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



72
73
74
 
# File 'lib/oci/core/models/tcp_options.rb', line 72

def hash
  [destination_port_range, source_port_range].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/core/models/tcp_options.rb', line 104

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



98
99
100
 
# File 'lib/oci/core/models/tcp_options.rb', line 98

def to_s
  to_hash.to_s
end